Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 4.37 KB

README.md

File metadata and controls

79 lines (53 loc) · 4.37 KB
Raw

Changelog Generator

Overview

This project is a Docker image that is used to generate a changelog in the kyma repository. It uses GitHub API to get pull requests with specified labels.

Prerequisites

To set up the project, you need the latest version of Docker.

Usage

Read how to build the Docker image and use it to generate either the full changelog with all released Kyma versions or a changelog only for the latest release.

Build the Docker image

To build the Docker image, run this command:

docker build -t changelog-generator .

Generate the full changelog

To generate a CHANGELOG.md file for all released Kyma versions, follow these steps:

  1. Create a CHANGELOG.md file under the specified absolute path to the repository. Use this command:
docker run --rm -v {absolutePathToRepository}:/repository -w /repository -e NEW_RELEASE_TITLE={releaseTitle} -e GITHUB_AUTH={githubToken} -e SSH_FILE={sshFilePath} -e CONFIG_FILE={configFilePath} -e SKIP_REMOVING_LATEST={skipRemovingLatest} changelog-generator sh /app/generate-full-changelog.sh --configure-git

Replace values in curly braces with proper details, where:

  • {absolutePathToRepository} is the absolute path to the repository.
  • {releaseTitle} is the currently released application title which specifies the release version.
  • {githubToken} is the GitHub API token with the read-only access to the repository.
  • {sshFilePath} is the path to the SSH file used for Git to authenticate with the repository.
  • {configFilePath} is a path to the package.json file used by the lerna-changelog tool.
  • {skipRemovingLatest} if set to true, removing the latest tag functionality is skipped.
  1. Commit and push the CHANGELOG.md file. Use this command:
docker run --rm -v {absolutePathToRepository}:/repository -w /repository -e BRANCH={currentBranch} -e NEW_RELEASE_TITLE={releaseTitle} -e SSH_FILE={sshFilePath} changelog-generator sh /app/push-full-changelog.sh --configure-git

Replace values in curly braces with proper details, where:

  • {absolutePathToRepository} is the absolute path to the repository.
  • {currentBranch} is the current Git branch name.
  • {releaseTitle} is the currently released application title which specifies the release version.
  • {sshFilePath} is the path to the SSH file used for Git to authenticate with the repository.

Generate the latest release changelog

To generate a changelog for a single release that contains merged pull requests for the latest Kyma version, run this command:

docker run --rm -v {absolutePathToRepository}:/repository -w /repository -e FROM_TAG={previousTag} -e TO_TAG={latestTag} -e NEW_RELEASE_TITLE={releaseTitle} -e GITHUB_AUTH={githubToken} -e SSH_FILE={sshFile} -e CONFIG_FILE={configFilePath} -e SKIP_REMOVING_LATEST={skipRemovingLatest} changelog-generator sh /app/generate-release-changelog.sh --configure-git

Replace values in curly braces with proper details, where:

  • {absolutePathToRepository} is the absolute path to the repository.
  • {previousTag} specifies the first tag which is included in the changelog. If not provided, the changelog is generated from the tag which precedes the latest tag used.
  • {latestTag} specifies the last tag which is included in the changelog. If not provided, the changelog is generated to the latest tag used.
  • {releaseTitle} is the currently released application title which specifies the release version.
  • {githubToken} is the GitHub API token with the read-only access to the repository.
  • {sshFilePath} is the path to the SSH file used for Git to authenticate with the repository.
  • {configFilePath} is a path to the package.json file used by the lerna-changelog tool.
  • {skipRemovingLatest} if set to true, removing the latest tag functionality is skipped.

The script generates a new ./.changelog/release-changelog.md file under the specified absolute path to the repository.

Development

This project uses the lerna-changelog generator and custom shell scripts to create a release changelog in the form of a CHANGELOG.md file.

Configure changelog generation

To specify the changelog generation settings, modify the package.json file under the app directory. See the lerna-changelog documentation for details.