在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
github-changelog-generator
Changelog generation has never been so easyFully automated changelog generation - This gem generates a changelog file based on tags, issues and merged pull requests (and splits them into separate lists according to labels) from GitHub Issue Tracker. Since you don't have to fill your What’s the point of a changelog?To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. Why should I care?Because software tools are for people. "Changelogs make it easier for users andcontributors to see precisely what notable changes have been made between eachrelease (or version) of the project." InstallationGitHub Changelog Generator is a Rubyprogram, distributed as a RubyGem. The Ruby language homepage has an Installation page. Install the gem like: $ gem install github_changelog_generator Depending on your system, you may need to run the shell as an Administrator (Windows),or use UsageRunning with CLI: github_changelog_generator -u github_username -p github_project Running with DockerUsing Docker is an alternative to installing Ruby and the gem. Example invocation: $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator
This generates a Output example
ParamsPrint help for all command-line options to learn more details: $ github_changelog_generator --help For more details about params, read the Wiki page: Advanced changelog generation examples Params FileIn your project root, you can put a params file named Example: unreleased=falsefuture-release=5.0.0since-tag=1.0.0 GitHub tokenGitHub only allows 50 unauthenticated requests per hour. Therefore, it's recommended to run this script with authentication by using a token. Here's how:
You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»" So, if you get a message like this: API rate limit exceeded for github_username.See: https://developer.github.com/v3/#rate-limiting It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.) Migrating from a manual changelogKnowing how dedicated you are to your project, you probably haven't been waiting for That's where If you have a Rake taskYou love Configure the task in your require 'github_changelog_generator/task'GitHubChangelogGenerator::RakeTask.new :changelog do |config| config.user = 'username' config.project = 'project-name' config.since_tag = '0.1.14' config.future_release = '0.2.0'end All command-line options can be passed to the You can look for params names from the parser source code (#setup_parser). For example, to translate the bugs label to Portuguese, instead of setting Features and advantages of this project
Using the summary section featureFor each version, you can add a release summary with text, images, gif animations,etc, and show new features and notes clearly to the user. This is done using GitHub metadata. Example: adding the release summary for v1.0.0:
![image](https://user-images.githubusercontent.com/12690315/45935880-006a8200-bfeb-11e8-958e-ff742ae66b96.png)Hello, World! :tada:
AlternativesHere is a wikipage list of alternatives that I found. But none satisfied my requirements. If you know other projects, feel free to edit this Wiki page! Projects using this libraryHere's a wikipage list of projects. If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it. If you are using Am I missing some essential feature?
FAQ
GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) BTW: I would like to support GitHub Releases in next releases ;) I'm not trying to compare the quality of handwritten and auto-generated logs. That said.... An auto-generated changelog really helps, even if you manually fill in the release notes!
When your Ruby is old, and you don't want to upgrade, and you want tocontrol which libraries you use, you can use Bundler. In a Gemfile, perhaps in a non-deployed group :development do gem 'github_changelog_generator', require: falseend Then you can keep back dependencies like rack, which currently is onlycompatible with Ruby >= 2.2.2. So, use an older version for your app byadding a line like this to the Gemfile: gem 'rack', '~> 1.6' This way, you can keep on using github_changelog_generator, even if youcan't get the latest version of Ruby installed.
Workaround: Create a ContributingWe have collected notes on how to contribute to this project in CONTRIBUTING.md. Contact usJoin the chat at gitter : github-changelog-generator LicenseGithub Changelog Generator is released under the MIT License. |
请发表评论