Skip to content

Commit ce4e86a

Browse files
authored
Updates the RELEASING.md to for changelog generation (#6739)
Updates the RELEASING.md to put the changelog generation after the build and using the tags. Signed-off-by: David Venable <dlv@amazon.com>
1 parent a97d381 commit ce4e86a

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

RELEASING.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -81,23 +81,6 @@ See the [README](release/script/release-notes/README.md) for the script for inst
8181
Once the release notes are ready, create a PR to merge them into `main`.
8282
Also tag this with the `backport {major}.{minor}` to create a PR that you can merge into your release branch.
8383

84-
### Create changelog
85-
86-
You can create a changelog using [git-release-notes](https://github.com/ariatemplates/git-release-notes).
87-
88-
```
89-
git fetch upstream
90-
git switch {major}.{minor}
91-
git fetch upstream --tags
92-
git pull
93-
git-release-notes {previousMajor}.{previousMinor}.{previousPatch}..HEAD markdown > release/release-notes/data-prepper.change-log-{major}.{minor}.{patch}.md
94-
git switch main
95-
```
96-
97-
Once the change log ready, create a PR to merge it into `main`.
98-
Also tag this with the `backport {major}.{minor}` to create a PR that you can merge into your release branch.
99-
100-
10184

10285
## <a name="performing-a-release">Performing a release</a>
10386

@@ -163,6 +146,23 @@ You can also check the Maven artifacts after the promote stage completes by view
163146

164147
After the release, there are a few other steps to clean up the repository.
165148

149+
### Create changelog
150+
151+
You can create a changelog using [git-release-notes](https://github.com/ariatemplates/git-release-notes).
152+
153+
```
154+
git fetch upstream
155+
git switch {major}.{minor}
156+
git fetch upstream --tags
157+
git pull
158+
git-release-notes {previousMajor}.{previousMinor}.{previousPatch}..{major}.{minor}.{patch} markdown > release/release-notes/data-prepper.change-log-{major}.{minor}.{patch}.md
159+
git switch main
160+
```
161+
162+
Once the change log is ready, create a PR to merge it into `main`.
163+
Also tag this with the `backport {major}.{minor}` to create a PR that you can merge into your release branch.
164+
165+
166166
### Update the release notes
167167

168168
The release process will have created a draft release for the new version.

0 commit comments

Comments
 (0)