Ensure files like License.txt, CODE_OF_CONDUCT.md and CONTRIBUTING.md exist on all repos across a GitHub account.
Add all the files you'd like to replicate across all repos to a new repo called
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install required_files
Initialize the client:
client = RequiredFiles::Client.new(YOUR_GITHUB_TOKEN)
Copy all files from a repo called
required-files to all other repos owned by the account:
Delete a file from all other repos owned by the account:
Update a file in all repos owned by the account with one from repo called
After 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/librariesio/required_files. 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.
The gem is available as open source under the terms of the MIT License.