| Name | Name | Last commit date | ||
|---|---|---|---|---|
This is a gem for maintaining MAINTAINERS files.
$ gem install maintainersSome use cases:
The only top-level configurable you might want to specify is the issues url.
maintainers create --issues https://github.com/gracehopper/newthing/issuesAt this point you might drop some comments in the resultant MAINTAINERS file.
Add users identified by github id, optionally specifying name, email address, and a comment.
maintainers add --github gracehopper --email grace@usnavy.gov --name "Grace Hopper"
maintainers add --github gracehopper --email grace@usnavy.gov --name "Grace Hopper" --comment "Maintains ENIAC"Remove user by specifying the github id:
maintainers remove --github gracehopperEmit a list of maintainers:
maintainers listmaintainers reportRun this from the root of your project.
maintainers validateSome commands (for now, just report) will make use of a github token if one is specified in an environment variable GITHUB_TOKEN.
To use this, you will need to generate a suitable github token like so:
GITHUB_TOKEN environment variableAfter checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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/puppetlabs/maintainers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.