search

babelfish-for-postgresql / babelfish_compass

Babelfish Compass: compatibility assessment tool for Babelfish for PostgreSQL
Apache License 2.0
108 stars 21 forks source link

Auto populate release body description #7

Closed avneettoor closed 2 years ago

avneettoor commented 2 years ago

Purpose

The purpose of this change is to auto populate the description of a release when a versioning tag is pushed through GitHub Actions.

How to use

Populate a file by the name of CHANGELOG.md with release details. E.g.

# 0.0.1
Sample description

Make sure to title the release using the markdown header level 1 (i.e. #). The parsing is dependant upon having a markdown header level 1 separating each release.

Create and push a tag with the following pattern: v*. For example:

git tag v0.0.1
git push origin v0.0.1

The workflow will trigger. A tag and a release, with the same name as the tag, will be created in the GitHub project. Notice how the description of the release gets auto populated with

# 0.0.1
Sample description

Try adding a new release version to the CHANGELOG and pushing a new tag

# 0.0.2
Another sample description

# 0.0.1
Sample description
git tag v0.0.2
git push origin v0.0.2

Notice how the description of this release gets auto populated with

# 0.0.2
Another sample description