https://github.com/mvz/rake-manifest
Rake tasks to generate and check a manifest file
https://github.com/mvz/rake-manifest
developer-tools hacktoberfest manifest ruby
Last synced: 9 months ago
JSON representation
Rake tasks to generate and check a manifest file
- Host: GitHub
- URL: https://github.com/mvz/rake-manifest
- Owner: mvz
- License: mit
- Created: 2020-08-07T12:38:06.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T10:48:57.000Z (over 1 year ago)
- Last Synced: 2025-04-02T10:37:51.229Z (over 1 year ago)
- Topics: developer-tools, hacktoberfest, manifest, ruby
- Language: Ruby
- Homepage:
- Size: 126 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rake::Manifest
Rake tasks to generate and check a manifest file
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rake-manifest'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install rake-manifest
## Usage
Add something like the following to your `Rakefile`:
```ruby
Rake::Manifest::Task.new do |t|
t.patterns = ["{docs,examples,lib}/**/*", "LICENSE.txt"] # Default is ["**/*"]
t.manifest_file = "MyManifest.txt" # Default is "Manifest.txt"
end
```
This will create the tasks `manifest:generate` and `manifest:check`.
Next, run `manifest:generate` to create your manifest file, and check it into
source control.
To use the manifest file, use something like the following in your gemspec:
```ruby
spec.files = File.read("Manifest.txt").split
```
You can use `manifest:check` to see if any files are not in the manifest. If
you have a task for building your gem, you can make it depend on
`manifest:check`. This will avoid building the gem with incorrect contents. For
example, if you're using the Bundler gem tasks, add this to your `Rakefile`:
```ruby
task build: "manifest:check"
```
## Development
After checking out the repo, run `bundle` to install dependencies. Then, run
`rake spec` to run the tests.
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/mvz/rake-manifest.
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT).