Reword the changelog fragments to better generate the CHANGELOG.md when we release 1.0. #3544
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmrodri
changed the title
92 tasks
camilamacedo86
approved these changes
Jul 27, 2020
joelanford
requested changes
Jul 27, 2020
Comment on lines
+5
to
+7
| 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`. |
There was a problem hiding this comment.
This should be consolidated with the removal of legacy metrics generation in Helm and Ansible operators fragments (again, in the release prep PR)
| @@ -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. | |||
There was a problem hiding this comment.
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
| 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` |
There was a problem hiding this comment.
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)
jmrodri
force-pushed
the
changelog-wordsmith
branch
from
61adfa1 to
ef724c0
Compare
|
New changes are detected. LGTM label has been removed. |
jmrodri
force-pushed
the
changelog-wordsmith
branch
from
ef724c0 to
70d30a4
Compare
jmrodri
force-pushed
the
changelog-wordsmith
branch
from
3dd4888 to
263e232
Compare
|
Closing this pull request in favor of the upcoming release PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change:
Reword the changelog fragments to better generate the CHANGELOG.md when we release 1.0.
Motivation for the change:
Preparing for a 1.0 CHANGELOG.
Checklist
If the pull request includes user-facing changes, extra documentation is required:
changelog/fragments(seechangelog/fragments/00-template.yaml)website/content/en/docs