[chore] added a new chloggen to track changes to the contrib #125
Conversation
bhanuba
changed the title
| @@ -288,6 +288,22 @@ chlog-preview: $(CHLOGGEN) | |||
| chlog-update: $(CHLOGGEN) | |||
There was a problem hiding this comment.
nit: do we still need the original chlog commands if we have our own version that is just for aws-cwa-dev branch?
There was a problem hiding this comment.
That can used to update the changelog for any API changes. If we can update in one file then we can remove it.
|
|
||
| git push origin "${BRANCH}" | ||
|
|
||
| gh pr create --title "[chore] Prepare release ${CANDIDATE_BETA}" --body " |
There was a problem hiding this comment.
Do we need this file? We are never "releasing" the OTEL agent, but just updating the component so we can reference it in CWAgent code.
There was a problem hiding this comment.
We can update with the command as well "make chlog-update-aws --version v1.1.1" . We can discuss the best way and we can work on it. For now we can store chnages in yaml files.
.github/workflows/changelog.yml
Outdated
| @@ -0,0 +1,93 @@ | |||
| # This action requires that any PR targeting the main branch should add a | |||
There was a problem hiding this comment.
nit: This action requires that any PR targeting the aws-cwa-dev branch
There was a problem hiding this comment.
Do we need this file? We are never "releasing" the OTEL agent, but just updating the component so we can reference it in CWAgent code.
There was a problem hiding this comment.
We can update with the command as well "make chlog-update-aws --version v1.1.1" . We can discuss the best way and we can work on it. For now we can store chnages in yaml files.
CONTRIBUTING-AWS.md
Outdated
|
|
||
| The name of your file must be unique since the last release. | ||
|
|
||
| During the collector release process, all `./chloggen-aws/*.yaml` files are transcribed into `CHANGELOG-aws.md` and then deleted. |
There was a problem hiding this comment.
Confused about this part. Do we have to run a release workflow to convert the yaml file into the Changelog or does the yaml file get converted after PR is merged?
There was a problem hiding this comment.
In general we will run the release for updating the changelog.md file. As we dont do the releases here mostly. We either have to run the command manually or we have to run the release only for the changelog update.
There was a problem hiding this comment.
This is an empty file, can we remove this?
CHANGELOG-AWS.md
Outdated
| # GO AWS cloudwatch agent Changelog | ||
|
|
||
| This changelog includes only clodwatch agent developer-facing changes. | ||
| Please checkout contributing file [CONTRIBUTING.md](./CONTRIBUTING.md) |
There was a problem hiding this comment.
We should be referencing CONTRIBUTING-AWS.md right?
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, labeled, unlabeled] |
There was a problem hiding this comment.
Based on previous conversations, I think the agreement is to render change log entry into CHANGELOG-AWS.md when a PR is merged.
Looks like this workflow checks if a changelog entry is added on PR creation, but is there a workflow to automatically convert the entry post-merge or am I missing something?
|
|
||
| on: | ||
| pull_request_review: | ||
| types: [ submitted ] |
There was a problem hiding this comment.
This will trigger every time a PR review is submitted. https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#running-a-workflow-when-a-pull-request-is-approved
Is the merged option what we are actually looking for? https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#running-your-pull_request-workflow-when-a-pull-request-merges
There was a problem hiding this comment.
LGTM.
I think it would be nice if we have a doc with screenshot that walks through the entire process of how we initiate the PR, add the template change log entry, then how the entry gets converted into change log. Or maybe even just add those details to the testing section would be great as well.
Description:
OTel has a way to enforce https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/.chloggen and essentially convert those into https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CHANGELOG.md and https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CHANGELOG-API.md as part of their releases.
We need a similar way of ensuring that every PR going to aws-cwa-dev branch will enforce a changelog entry file that will use a new template relevant to us. This template should ask the author of the PR additional details. The end goal is to create a similar CHANGELOG-AWS.md file that we will update with every release.
Link to tracking Issue:
Testing:
Did manual testing with the commands
make chlog-new-aws. ---> To create yaml file in .chloggen-aws with branch name.
make chlog-validate-aws. ---> To validate the format of the content added to the yaml file
make chlog-preview-aws. ---> To see the preview of chloggen-aws.md file
make chlog-update-aws --->To update the content to chloggen-aws.md file
Tested the changelog workflow checks for manual chnages in the CHANGELOG_AWS.md and checks for the file changes in the directory.
It is going to update in CHANGELOG-AWS.md this way
Documentation:
Added a new CONTRIBUTING-AWS.md that helps us in guiding the creation of changelog yaml files and update in the CHANGELOG-AWS.md file.