Skip to content

Commit

Permalink
make get_changes modify changelog directly and update readme in dev (#…
Browse files Browse the repository at this point in the history
…2473)

Signed-off-by: Michael Robinson <merobi@gmail.com>
  • Loading branch information
merobi-hub authored Apr 11, 2023
1 parent 2a41675 commit cf0ba3e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ The `get_changes.sh` script uses a fork of saadmk11/changelog-ci to get all
merged changes between two specified releases. To get all changes since the latest
release, set `END_RELEASE_VERSION` to the planned next release.

The changes will appear in this directory in a new file, CHANGES.md.
The changes will appear at the top of CHANGELOG.md.

#### Requirements

Python 3.10 or newer is required.
See the requirements.txt file for required dependencies.

The script also requires that the following environment variables be set:
Expand All @@ -18,6 +19,8 @@ The script also requires that the following environment variables be set:

For example: `export END_RELEASE_VERSION=0.21.0`.

Use the planned next release for the end release version.

For instructions on creating a GitHub personal access token to use the GitHub API,
see: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token.

Expand Down
2 changes: 1 addition & 1 deletion dev/get_changes.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Copyright 2018-2023 contributors to the Marquez project
# SPDX-License-Identifier: Apache-2.0

export INPUT_CHANGELOG_FILENAME=CHANGES.md
export INPUT_CHANGELOG_FILENAME=../CHANGELOG.md
export GITHUB_REPOSITORY=MarquezProject/marquez

git clone --branch add-testing-script --single-branch git@github.com:merobi-hub/changelog-ci.git
Expand Down

0 comments on commit cf0ba3e

Please sign in to comment.