jenkins/core-changelog-generator
Tool for generating Jenkins core changelogs
10K+
The tools in this repo help with the creation of Jenkins core changelog drafts (weekly, LTS). The Jenkins changelog is maintained in the jenkins-infra/jenkins.io repository, and the generated pull requests should be submitted there.
This tool can be used to generate a first draft of a Jenkins release's changelog.
cd /path/to/clone/of/jenkinsci/jenkins.git
export GITHUB_AUTH=github_username:github_token
/path/to/generate-jenkins-changelog.rb <VERSION>
/path/to/generate-jenkins-changelog.rb <COMMIT>..<COMMIT>
There is also a Dockerized version available:
/github/workspace
volume, e.g. -v $(pwd)/test/jenkins:/github/workspace
.
In such case there will be also a changelog.yaml
file generated in the root of the repoGenerating changelog for pending changes:
export GITHUB_AUTH=github_username:github_token
docker run -e GITHUB_AUTH=${GITHUB_AUTH} -v $(pwd):/github/workspace --rm jenkins/core-changelog-generator
Generating changelog for a release:
export GITHUB_AUTH=github_username:github_token
docker run -e GITHUB_AUTH=${GITHUB_AUTH} -v $(pwd):/github/workspace --rm jenkins/core-changelog-generator 2.204
This tool can be used to generate an LTS changelog for all the backported issues (labeled 2.xyz.w-fixed
in Jira) with corresponding changelog entries in the weekly changelog YAML file.
Weekly changelog YAML is optional, it will be downloaded from the jenkins.io repository if not specified.
export JIRA_AUTH=jira_username:jira_password
/path/to/lts-backports-changelog.rb <VERSION> <PATH/TO/weekly.yml>
-e CHANGELOG_TYPE=lts
variablegenerate-jenkins-changelog
also apply hereExample:
docker run -e GITHUB_AUTH=${GITHUB_AUTH} -e JIRA_AUTH=${JIRA_AUTH} -e CHANGELOG_TYPE=lts -v $(pwd):/github/workspace --rm jenkins/core-changelog-generator 2.109.2
docker pull jenkins/core-changelog-generator