Skip to content

Reword the changelog fragments to better generate the CHANGELOG.md when we release 1.0. #3544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jmrodri wants to merge 28 commits into from
Closed

Reword the changelog fragments to better generate the CHANGELOG.md when we release 1.0. #3544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
ee1da38
Escape sample variable; remove extra whitespace
jmrodri Jul 24, 2020
09cc771
Reworded a bit; escaped EnqueueResuestForObject
jmrodri Jul 24, 2020
fe42bd0
Reworded; Properly escaped flag and variable names;
jmrodri Jul 24, 2020
2d25117
Escape bundle.Dockerfile and annotations.yaml
jmrodri Jul 24, 2020
c0ddc9f
Spell mechanism correctly
jmrodri Jul 24, 2020
c910f4b
Use proper names for Ansible & Helm; Some grammar changes
jmrodri Jul 24, 2020
ac7045d
A few grammar nits. Use proper name for SDK.
jmrodri Jul 24, 2020
84d6b41
Use Changed instead of Changes
jmrodri Jul 24, 2020
9eec63a
Use Changed instead of Changes
jmrodri Jul 24, 2020
b50289f
Use Changed instead of Changes
jmrodri Jul 24, 2020
5a5f966
Use Removed instead of Remove
jmrodri Jul 24, 2020
76e490e
Use Removed instead of Remove
jmrodri Jul 24, 2020
f614bdf
Use Removed instead of Remove
jmrodri Jul 24, 2020
13e121f
Properly escaped function names
jmrodri Jul 24, 2020
4530032
Add changelog entry for CVE fix.
jmrodri Jul 24, 2020
18b0226
Use proper object
jmrodri Jul 25, 2020
c1a5fa9
Favor the removal PR over the addition; reword the removal
jmrodri Jul 25, 2020
f40ce02
Reword Ansible & Helm operator use controller-runtime leader
jmrodri Jul 25, 2020
45fd4c4
Reword scorecard namespace defaulting
jmrodri Jul 25, 2020
c5bfdf4
Reworded alpha scorecard promotion
jmrodri Jul 25, 2020
458118c
Reworded new & add api removal from Ansible & Helm
jmrodri Jul 25, 2020
b33f360
Use Removed; Link to operator-lib
jmrodri Jul 25, 2020
c6f6585
Explain Ansible & Helm operators now use InstrumentedEnqueueRequestFo…
jmrodri Jul 25, 2020
468313a
Reword to Removed
jmrodri Jul 25, 2020
cff9e28
Reword migration steps
jmrodri Jul 27, 2020
9d374b8
Remove Valid only warning
jmrodri Jul 27, 2020
f425d61
Reword Remove legacy to support in legacy projects
jmrodri Jul 27, 2020
263e232
Fix typo
jmrodri Jul 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions changelog/fragments/ansible-leader-election.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# release notes and/or the migration guide
entries:
- description: >
In the Ansible operator, use controller-runtime's lease-based leader
election instead of SDK's leader-for-life mechnism.
The Ansible operator now uses the controller-runtime's lease-based leader
election instead of SDK's leader-for-life mechanism.

kind: "change"
breaking: false
13 changes: 6 additions & 7 deletions changelog/fragments/ansible-metrics-addr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
entries:
- description: >
Added `--metrics-addr` flag to ansible operator to make it configurable, and
changed the default from `:8383` to `:8080`
Added `--metrics-addr` flag to the Ansible operator to make it configurable, and
changed the default port from `:8383` to `:8080`

kind: "change"

# Is this a breaking change?
breaking: true

migration:
header: Default ansible operator metrics port changed
header: Default Ansible operator metrics port has changed
body: >
To continue using port 8383, specify `--metrics-addr=:8383` when you start the operator.

4 changes: 2 additions & 2 deletions changelog/fragments/ansible-operator-optional-case.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ entries:
- description: >
The `snakeCaseParameters` option has been added to the `watches.yaml` for
Ansible-based Operators. This allows the user to configure whether parameters
in the resource spec are automatically converted from camelCase to snake_case.
The default is `true`, so there is no behavior change for existing operators,
in the resource spec are automatically converted from `camelCase` to `snake_case`.
The default is `true`, so there is no behavior change for existing operators,
but it can now be disabled.

kind: "addition"
Expand Down
2 changes: 1 addition & 1 deletion changelog/fragments/cmd-legacy-helm.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# release notes and/or the migration guide
entries:
- description: >
The commands `operator-sdk new --type=helm` and `operator-sdk add api` are no longer supported for Helm-based Operators.
Removed legacy `new` and `add api` commands from Helm-based Operators.

# kind is one of:
# - addition
Expand Down
7 changes: 0 additions & 7 deletions changelog/fragments/enqueue-object-handler.yaml
View file
Open in desktop

This file was deleted.

14 changes: 14 additions & 0 deletions changelog/fragments/fixed-cve.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# entries is a list of entries to include in
# release notes and/or the migration guide
entries:
- description: >
Fixed CVE-2020-14040 by updating to `golang.org/x/text/0.3.3`

# - bugfix
kind: "bugfix"

# Is this a breaking change?
breaking: false

# What is the pull request number (without the "#")?
pull_request_override: 3458
2 changes: 1 addition & 1 deletion changelog/fragments/helm-leader-election.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
entries:
- description: >
In the Helm operator, use controller-runtime's lease-based leader
The Helm operator now uses the controller-runtime's lease-based leader
election instead of SDK's leader-for-life mechanism.

kind: "change"
Expand Down
6 changes: 3 additions & 3 deletions changelog/fragments/helm-metrics-addr.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
entries:
- description: >
Added `--metrics-addr` flag to helm operator to make it configurable, and
changed the default from `:8383` to `:8080`
Added `--metrics-addr` flag to the Helm operator to make it configurable, and
changed the default port from `:8383` to `:8080`
Copy link
Copy Markdown
Contributor

@camilamacedo86 camilamacedo86 Jul 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO we can combine the metrics change for Ansible and Helm:

Breaking change: (Valid only for Ansible/Helm-based Operators). Added --metrics-addr flag to make it configurable, and changed the default port used by the metric endpoint binds to from :8383 to :8080. (#3489, #3440)


kind: "change"

# Is this a breaking change?
breaking: true

migration:
header: Default helm operator metrics port changed
header: Default Helm operator metrics port has changed
body: >
To continue using port 8383, specify `--metrics-addr=:8383` when you start the operator.
5 changes: 0 additions & 5 deletions changelog/fragments/modify-ansible-flags.yaml
View file
Open in desktop

This file was deleted.

10 changes: 5 additions & 5 deletions changelog/fragments/mv-EnqueueRequestForAnnotation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
entries:
- description: >
Remove the implementation for `EnqueueRequestForAnnotation` handler from sdk repository and
reference it from operator-lib instead.
Removed the implementation for `EnqueueRequestForAnnotation` handler from the SDK repository and
referenced it from [operator-lib](https://github.com/operator-framework/operator-lib/blob/main/handler/enqueue_annotation.go) instead.
kind: "change"

# Is this a breaking change?
breaking: true

Expand All @@ -12,5 +12,5 @@ entries:
migration:
header: Move the implementation of `EnqueueRequestForAnnotation` handler
body: >
The implementation of `EnqueueRequestForAnnotation` handler has been removed from Operator SDK repository
and is now imported from Operator-lib.
Import "github.com/operator-framework/operator-lib/handler" to continue using the
`EnqueueRequestForAnnotation` handler.
2 changes: 1 addition & 1 deletion changelog/fragments/remove-pkg-predicate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
entries:
- description: >
Remove `pkg/predicate`: `ResourceFilterPredicate` is now available via
Removed `pkg/predicate`: `ResourceFilterPredicate` is now available via
`pkg/ansible/predicate.NewResourceFilterPredicate()`; `GenerationChangedPredicate` has been renamed,
modified, and moved (see this [operator-lib PR](https://github.com/operator-framework/operator-lib/pull/11)
for details).
Comment thread
jmrodri marked this conversation as resolved.
Expand Down
4 changes: 2 additions & 2 deletions changelog/fragments/remove-test-framework.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
entries:
- description: Remove `test` subcommand and the test framework `pkg/test`.
- description: Removed `test` subcommand and the test framework `pkg/test`.
kind: "removal"
pull_request_override: 3409
breaking: true
migration:
header: Remove `test` subcommand and the test framework `pkg/test`
header: Removed `test` subcommand and the test framework `pkg/test`
body: TBD
12 changes: 7 additions & 5 deletions changelog/fragments/rename-max-workers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
entries:
- description: >
**(Valid only for Ansible/Helm-based Operators)**. The flag `--max-workers` is no longer supported.
Use `--max-concurrent-reconciles` instead.
The Ansible operator's `--max-workers` flag and `WORKERS_<Kind>_<Group>`
environment variable have been renamed to `--max-concurrent-reconciles` and
`MAX_CONCURRENT_RECONCILES_<Kind>_<Group>` respectively.
kind: "change"
breaking: true
migration:
header: Flag `max-workers` is no longer supported.
header: Flag `max-workers` and `WORKERS_<Kind>_<Group>` environment variable are no longer supported.
body: |
The flag `--max-workers` is no longer supported with ansible/helm binaries. It has been
renamed to `--max-concurrent-reconciles`.
The `--max-workers` flag and `WORKERS_<Kind>_<Group>` environment variable are no longer supported
with the Ansible operator. They have been renamed to `--max-concurrent-reconciles` and
`MAX_CONCURRENT_RECONCILES_<Kind>_<Group>` respectively.

6 changes: 3 additions & 3 deletions changelog/fragments/rm-ansible-metrics.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
# release notes and/or the migration guide
entries:
- description: >
Remove legacy metrics generation code.
Removed legacy metrics generation code from Ansible-based Operators.
kind: "removal"
# Is this a breaking change?
breaking: true
migration:
header: Remove legacy metrics generation code from cmd/ansible-operator/main.go, and tests/e2e-anisble.sh checks for servicemonitor.
body: TBD
header: Removed legacy metrics generation code from cmd/ansible-operator/main.go, and tests/e2e-anisble.sh checks for servicemonitor.
body: TBD
2 changes: 1 addition & 1 deletion changelog/fragments/rm-cmd-legacy-ansible.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# release notes and/or the migration guide
entries:
- description: >
The commands `operator-sdk new --type=ansible` and `operator-sdk add api` are no longer supported for Ansible-based Operators.
Removed legacy `new` and `add api` commands from Ansible-based Operators.
Copy link
Copy Markdown
Contributor

@camilamacedo86 camilamacedo86 Jul 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All legacy removals IMO could be replaced for one fragment:

# entries is a list of entries to include in
# release notes and/or the migration guide
entries:
  - description: >
      Remove support for the legacy layout. Operator SDK has a new CLI and project layout that is aligned with Kubebuilder. (//todo: add all pr's numbers)
      
    kind: "removal"
    # Is this a breaking change?
    breaking: yes
    # Migration can be defined to automatically add a section to
    # the migration guide. This is required for breaking changes.
    migration:
      header: Migrate your projects for the new layout
      body: >
        Operator SDK has a new CLI and project layout that is aligned with Kubebuilder.
        See `operator-sdk init -h` and the following doc on how to scaffold a new project:
        To migrate existing projects to the new layout see the migrations guides in
        https://sdk.operatorframework.io.
        - For Go-based Operators: https://master.sdk.operatorframework.io/docs/building-operators/golang/project_migration_guide/
        - For Helm-based Operators: https://master.sdk.operatorframework.io/docs/building-operators/helm/migration/
        - For Ansible-based Operators: TBD

Wdyt @joelanford


# kind is one of:
# - addition
Expand Down
4 changes: 2 additions & 2 deletions changelog/fragments/rm-helm-metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
# release notes and/or the migration guide
entries:
- description: >
Remove legacy metrics generation code.
Removed legacy metrics generation code from Helm-based Operators.
kind: "removal"
# Is this a breaking change?
breaking: true
migration:
header: Remove legacy metrics generation code from cmd/helm-operator/main.go, and test-e2e-helm.sh checks for servicemonitor.
body: TBD
body: TBD
4 changes: 2 additions & 2 deletions changelog/fragments/rm-legacy-bundle-cmds.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
# release notes and/or the migration guide
entries:
- description: >
Remove legacy "bundle create/validate" commands
Removed `bundle create` command and `bundle validate` support in legacy projects
kind: "removal"
# Is this a breaking change?
breaking: true
migration:
header: Remove legacy "bundle create/validate" commands
header: Remove `bundle create` command and `bundle validate` support in legacy projects
body: TBD
2 changes: 1 addition & 1 deletion changelog/fragments/rm-legacy-gen-bundle.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# release notes and/or the migration guide
entries:
- description: >
Remove legacy generate bundle command
Removed `generate bundle` command support in legacy projects.
kind: "removal"
# Is this a breaking change?
breaking: true
Expand Down
2 changes: 1 addition & 1 deletion changelog/fragments/rm-legacy-gen-csv.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# release notes and/or the migration guide
entries:
- description: >
Remove legacy generate csv command
Removed legacy `generate csv` command
kind: "removal"
# Is this a breaking change?
breaking: true
Expand Down
4 changes: 2 additions & 2 deletions changelog/fragments/rm-legacy-gen-packagemanifests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
# release notes and/or the migration guide
entries:
- description: >
Remove legacy generate packagemanifests command
Removed `generate packagemanifests` command support in legacy projects
kind: "removal"
# Is this a breaking change?
breaking: true
migration:
header: Remove legacy generate packagemanifests command
header: Remove generate packagemanifests command support in legacy projects
body: TBD
2 changes: 1 addition & 1 deletion changelog/fragments/rm-legacy-go.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
entries:
- description: >
Removed legacy go CLI subcommands and features: `add`, `migrate`
Removed support in legacy Go projects for CLI subcommands and features: `add`, `migrate`
`print-deps`, `generate k8s`, `generate crds`, and `scorecard`.
kind: removal
breaking: true
Expand Down
2 changes: 1 addition & 1 deletion changelog/fragments/rm-legacy-run.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# release notes and/or the migration guide
entries:
- description: >
Remove legacy `run` and `cleanup` subcommands
Removed `run` and `cleanup` subcommands support in legacy projects

kind: "removal"

Expand Down
4 changes: 2 additions & 2 deletions changelog/fragments/rm-pkg-metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# release notes and/or the migration guide
entries:
- description: >
Removed `pkg/metrics` and its helpers "GenerateAndServeCRMetrics()" and
"GetNamespacesForMetrics()".
Removed `pkg/metrics` and its helpers `GenerateAndServeCRMetrics()` and
`GetNamespacesForMetrics()`.

kind: "removal"

Expand Down
2 changes: 1 addition & 1 deletion changelog/fragments/scorecard-bundle-metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
entries:
- description: >
`generate bundle` now adds scorecard bundle metadata to bundle.Dockerfile and annotations.yaml
`generate bundle` now adds scorecard bundle metadata to `bundle.Dockerfile` and `annotations.yaml`
if `--overwrite` is set (the default in a project's `Makefile`) or both files do not exist.
kind: addition
breaking: false
7 changes: 3 additions & 4 deletions changelog/fragments/scorecard-default-ns.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
entries:
- description: >
Changes the scorecard command to look for a namespace in the
kubeconfig instead of defaulting to 'default' when the
namespace is not defined on the command line flag. If a namespace
can not be found in the kubeconfig file, then 'default' is used.
When a namespace is not provided on the command line, the scorecard command
now looks for a namespace in the kubeconfig. If a namespace can not be found
in the kubeconfig file, then 'default' is used.

kind: "change"

Expand Down
3 changes: 1 addition & 2 deletions changelog/fragments/scorecard-move-alpha.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
entries:
- description: >
Changes the alpha scorecard command to become the standard scorecard
command.
The `alpha scorecard` command has been promoted to the standard scorecard command.

kind: "change"

Expand Down
4 changes: 2 additions & 2 deletions changelog/fragments/scorecard-parallel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
entries:
- description: >
Changes the scorecard configuration format to include a new top-level
Changed the scorecard configuration format to include a new top-level
Comment thread
jmrodri marked this conversation as resolved.
`stages` field, which allows users to define stages of tests and to
enable parallelism within each stage.

Expand Down Expand Up @@ -28,7 +28,7 @@ entries:
stages field, and move your test definitions under one or more stages.

**Example**

```yaml
tests:
- image: quay.io/operator-framework/scorecard-test:dev
Expand Down
15 changes: 4 additions & 11 deletions changelog/fragments/use-operator-lib-metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,11 @@
# release notes and/or the migration guide
entries:
- description: >
Remove the implementation for `InstrumentedEnqueueRequestForObject`
handler from SDK repository and reference it from operator-lib instead.
Ansible & Helm-based Operators switched to using the `InstrumentedEnqueueRequestForObject` from
[operator-lib](https://github.com/operator-framework/operator-lib/blob/main/handler/instrumented_enqueue_object.go)
instead of controller-runtime's `EnqueueRequestForObject`.
Comment on lines +5 to +7
Copy link
Copy Markdown
Member

@joelanford joelanford Jul 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be consolidated with the removal of legacy metrics generation in Helm and Ansible operators fragments (again, in the release prep PR)


kind: "change"

# Is this a breaking change?
breaking: true

# Migration can be defined to automatically add a section to
# the migration guide. This is required for breaking changes.
migration:
header: Move the implementation of `InstrumentedEnqueueRequestForObject` handler
body: >
The implementation of `InstrumentedEnqueueRequestForObject` handler has been
removed from Operator SDK repository and is now imported from operator-lib.
breaking: false