This gem is intended to be used from the CLI. If needed, it can be importing and extended as required.
Add this line to your application's Gemfile:
gem 'services-changelog'
And then execute:
$ bundle
Or install it yourself as:
$ gem install services-changelog
The available commands are:
Commands:
changelog new [NAME] # Creates a new changelog entry
changelog parse # Lists all changelog entries
changelog version # Print version
The system expects a folder structure setup in your project, with a list of yaml files documenting your changelog entries:
changelog/
2022.01.01/
feature1.yaml
feature2.yaml
The changelog generation config can be changed at multiple levels:
This is the base config for the changelog and has the following options:
title: "Changelog" # Change the default title of the changelog
intro: "This is my changelog"
This is the version meta file - allowing extra metadata for the version declaration.
description: "This version was aimed at improving the application."
These files are added for every line of the changelog you wish to add:
title: 'Added initial proof of concept and basic ideas'
type: 'Added'
description: ''
merge_request: null
issue: null
author: null
After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/example-ruby-gem.
The gem is available as open source under the terms of the MIT License.
FAQs
Unknown package
We found that services-changelog demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.