From 45c87a78b52e7bebf831d0143b45e479235ce390 Mon Sep 17 00:00:00 2001 From: Daphne Yang <139700604+daphne-sfdc@users.noreply.github.com> Date: Tue, 19 Dec 2023 22:09:51 -0500 Subject: [PATCH] chore: update publishing.md with the automated changelog generation process (#5286) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: update publishing.md with the automated changelog generation process * chore: add word * Update contributing/publishing.md Co-authored-by: Cristina Cañizales <113132642+CristiCanizales@users.noreply.github.com> --------- Co-authored-by: Cristina Cañizales <113132642+CristiCanizales@users.noreply.github.com> --- contributing/publishing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/publishing.md b/contributing/publishing.md index 034d11676b..429a7669b7 100644 --- a/contributing/publishing.md +++ b/contributing/publishing.md @@ -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.