Repository files navigation

A Gitlab release note generator that generates release note on latest tag

• Generate release note on the latest tag based on merge requests and issues

• Distinguished title with issues or merge requests that have the following labels:enhancement,breaking change,feature andbug

  (Note. if an issue or merge request that has 2 or more labels, that issue or merge request will be displayed again under the corresponding title)

• Can be integrated as a CD service. Tutorial below

1. Find the latest tag
2. Find the previous tag that is on the same branch as the latest tag.
3. Locate the date range between the latest and the previous tag. If there is only a tag in the project, then thefrom date will be the project creation date and theto date will be that tag's creation date.
4. Find allMerged merge requests andClosed issues within that time range
5. Generate a release note/changelog based on the findings above.

• NodeJS ^16.x.x OR docker
• A gitlab personal access token withapi permission.How to Tutorial

docker container run -e GITLAB_PERSONAL_TOKEN=gitlabSampleToken -e GITLAB_PROJECT_ID=12345678 -e TARGET_BRANCH=sampleTargetBranch -e TARGET_TAG_REGEX=sampleRegex 00freezy00/gitlab-release-note-generator

• Fill in the parameters mainlyGITLAB_PERSONAL_TOKEN,GITLAB_PROJECT_ID,TARGET_BRANCH(optional. Use it only if you want to find tags in the same specific branch) andTARGET_TAG_REGEX (optional. Can use it to distinguish master or develop branch version bump) inapp/env.js or feed it inprocess.env through npm
• npm install
• npm start
• After couple seconds, latest tag should have a release note

1. Need to pass ingitlab personal access token as a CI variable

2. c/p the.sample.gitlab-ci.yml to your gitlab ci.

   What's included in the sample gitlab CI script

   • generate-release-note job. Generates a release note on the tag after detecting tag push with this regex/^[0-9]+.[0-9]+.[0-9]+(-[0-9]+)?$/
   • tag-after-deployment job (optional). Tag the commit that contains a version bump with this regex/^[0-9]+.[0-9]+.[0-9]+(-[0-9]+)?$/.Require ssh key to work.

3. Customise the gitlab ci script to your need

Reference gitlab repo:generator test

These can be specified using environment variables

• GITLAB_API_ENDPOINT: Your gitlab instaqnce's endpoint
  • Defaulthttps://gitlab.com/api/v4
• GITLAB_PERSONAL_TOKEN: Grant api read/access permission
• GITLAB_PROJECT_ID: Your project id that is located under settings > general
• TARGET_BRANCH: The branch to look for release tags (ie master)
• TARGET_TAG_REGEX: Regular expression of the release tags to search (ie: ^release-.*$)
• TZ: The timezone for your release notes
  • Default "Australia/Melbourne"
• ISSUE_CLOSED_SECONDS: The amount of seconds to search after the last commit, useful for Merge Requests that close their tickets a second after the commit.
  • Default 0

export GITLAB_PERSONAL_TOKEN=MYGITLABACCESSTOKENexport GITLAB_PROJECT_ID=99export GITLAB_API_ENDPOINT=https://my.gitlab.com/api/v4// run docker to build mylocal versiondocker build -t local-gitlab-release-note-generator.// run mylocal versiondocker container run \  -e TZ=America/New_York \  -e GITLAB_API_ENDPOINT=$GITLAB_API_ENDPOINT \  -e GITLAB_PERSONAL_TOKEN=$GITLAB_PERSONAL_TOKEN \  -e GITLAB_PROJECT_ID=$GITLAB_PROJECT_ID \  -e TARGET_BRANCH=master \  -e TARGET_TAG_REGEX=^release-.*$ \  local-gitlab-release-note-generator

• Release notes generation on selected tag
• Customise template for the release note

Thanks togithub-changelog-generator for inspiring me to make this app. Sorry, I couldn't wait any longer for that gitlab feature to be merged in.