{"id":13994436,"url":"https://github.com/librariesio/required_files","last_synced_at":"2025-04-23T01:31:32.260Z","repository":{"id":66148926,"uuid":"47931001","full_name":"librariesio/required_files","owner":"librariesio","description":":open_file_folder: Ensure some files exist in all your repos","archived":true,"fork":false,"pushed_at":"2018-04-10T10:06:03.000Z","size":38,"stargazers_count":11,"open_issues_count":8,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T05:47:29.717Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://libraries.io/github/librariesio/required_files","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/librariesio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null}},"created_at":"2015-12-13T18:26:01.000Z","updated_at":"2024-11-14T19:28:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"5d98b03f-eb20-4dce-aa35-52b1aac221ca","html_url":"https://github.com/librariesio/required_files","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/librariesio%2Frequired_files","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/librariesio%2Frequired_files/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/librariesio%2Frequired_files/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/librariesio%2Frequired_files/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/librariesio","download_url":"https://codeload.github.com/librariesio/required_files/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250352320,"owners_count":21416470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-09T14:02:52.426Z","updated_at":"2025-04-23T01:31:31.745Z","avatar_url":"https://github.com/librariesio.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# RequiredFiles\n\nEnsure files like License.txt, CODE_OF_CONDUCT.md and CONTRIBUTING.md exist on all repos across a GitHub account.\n\nAdd all the files you'd like to replicate across all repos to a new repo called `required-files`\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'required_files'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install required_files\n\n## Usage\n\nInitialize the client:\n\n```ruby\nclient = RequiredFiles::Client.new(YOUR_GITHUB_TOKEN)\n```\n\nCopy all files from a repo called `required-files` to all other repos owned by the account:\n\n```ruby\nclient.copy_files_for_account('librariesio')\n```\n\nDelete a file from all other repos owned by the account:\n\n```ruby\nclient.delete_file_for_account('librariesio', 'CONTRIBUTING.md')\n```\n\nUpdate a file in all repos owned by the account with one from repo called `required-files`:\n\n```ruby\nclient.update_file_for_account('librariesio', '.github/CONTRIBUTING.md')\n```\n\n## Development\n\nAfter 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.\n\nTo 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).\n\n## Contributing\n\nBug 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.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibrariesio%2Frequired_files","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibrariesio%2Frequired_files","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibrariesio%2Frequired_files/lists"}