https://github.com/librariesio/required_files
:open_file_folder: Ensure some files exist in all your repos
https://github.com/librariesio/required_files
Last synced: about 1 year ago
JSON representation
:open_file_folder: Ensure some files exist in all your repos
- Host: GitHub
- URL: https://github.com/librariesio/required_files
- Owner: librariesio
- License: mit
- Archived: true
- Created: 2015-12-13T18:26:01.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-04-10T10:06:03.000Z (about 8 years ago)
- Last Synced: 2025-03-24T05:47:29.717Z (about 1 year ago)
- Language: Ruby
- Homepage: https://libraries.io/github/librariesio/required_files
- Size: 37.1 KB
- Stars: 11
- Watchers: 2
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# RequiredFiles
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 `required-files`
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'required_files'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install required_files
## Usage
Initialize the client:
```ruby
client = RequiredFiles::Client.new(YOUR_GITHUB_TOKEN)
```
Copy all files from a repo called `required-files` to all other repos owned by the account:
```ruby
client.copy_files_for_account('librariesio')
```
Delete a file from all other repos owned by the account:
```ruby
client.delete_file_for_account('librariesio', 'CONTRIBUTING.md')
```
Update a file in all repos owned by the account with one from repo called `required-files`:
```ruby
client.update_file_for_account('librariesio', '.github/CONTRIBUTING.md')
```
## Development
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](https://rubygems.org).
## Contributing
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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).