Skip to content

Commit

Permalink
chore: update publishing.md with the automated changelog generation p…
Browse files Browse the repository at this point in the history
…rocess (#5286)

* chore: update publishing.md with the automated changelog generation process

* chore: add word

* Update contributing/publishing.md

Co-authored-by: Cristina Cañizales <[email protected]>

---------

Co-authored-by: Cristina Cañizales <[email protected]>
  • Loading branch information
daphne-sfdc and CristiCanizales authored Dec 20, 2023
1 parent 22a1131 commit 45c87a7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion contributing/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If any code changes are made between the time the release branch is automaticall

## Updating the Change Log

After the release branch is created, the changelog needs to be updated. To do so, the engineer should go into VSCode, pull the latest changes, and switch to the release branch. Then, they should open a Terminal window and run `npm run changelog` to generate the changelog entry for the upcoming release. This task will gather commits that should be published (like `feat` or `fix`) and write the update to `CHANGELOG.md`. If there are no commits worth publishing (for instance, if everything was a `chore` or a `ci` commit), then the changelog entry for the upcoming release can be skipped. If a changelog is necessary, the engineer will then push the changelog to the release branch with the commit name of `chore: generated CHANGELOG for vXX.YY.ZZ`, where XX.YY.ZZ are the numbers of the current release.
The changelog will be automatically generated as part of the Create Release Branch workflow. This task will gather commits that should be published (like `feat` or `fix`) and write the update to `CHANGELOG.md`. If there are no commits worth publishing (for instance, if everything was a `chore` or a `ci` commit), then the changelog entry for the upcoming release can be skipped. The workflow will then push the changelog to the release branch with the commit name of `chore: generated CHANGELOG for vXX.YY.ZZ`, where XX.YY.ZZ are the numbers of the current release.

The engineer should work with the team and doc writer to update and finalize the contents of the changelog. During the update process, if the writer wants to make further changes to changelog through the browser, they can do that by switching the branch from develop to release/vXX.YY.ZZ and go to `CHANGELOG.md` and clicking on the pencil icon to edit the file.

Expand Down

0 comments on commit 45c87a7

Please sign in to comment.