Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bobf/strong_versions
Enforce a strict versioning policy in your Gemfile
https://github.com/bobf/strong_versions
bundle bundler gem gemfile rubocop ruby
Last synced: 4 months ago
JSON representation
Enforce a strict versioning policy in your Gemfile
- Host: GitHub
- URL: https://github.com/bobf/strong_versions
- Owner: bobf
- License: mit
- Created: 2018-10-29T09:16:34.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-12T11:31:09.000Z (over 4 years ago)
- Last Synced: 2024-07-19T23:49:06.131Z (4 months ago)
- Topics: bundle, bundler, gem, gemfile, rubocop, ruby
- Language: Ruby
- Size: 3.56 MB
- Stars: 27
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StrongVersions
# Overview
_StrongVersions_ enforces a strict policy on your `Gemfile` requirements:
* The pessimistic `~>` operator must be used for all gem requirement definitions.
* If the gem version is greater than 1, the requirement format must be `major.minor`, e.g. `'~> 2.5`'
* If the gem version is less than 1, the requirement format must be `major.minor.patch`, e.g. `'~> 0.8.9'`
* A lower/upper bound can be specified as long as a valid pessimistic version is also specified, e.g. `'~> 8.4', '< 8.6.7'`
* All gems with a `path` or `git` source are ignored, e.g. `path: '/path/to/gem'`, `git: 'https://github.com/bobf/strong_versions'`
* All gems specified in the [ignore list](#ignore) are ignored.
Any gems that do not satisfy these rules will be included in the _StrongVersions_ output with details on why they did not meet the standard.
When all gems in a `Gemfile` follow this convention it SHOULD always be safe to run `bundle update` (assuming all gems adhere to [Semantic Versioning](https://semver.org/)).
## Installation
Add the gem to your `Gemfile`
```ruby
gem 'strong_versions', '~> 0.4.5'
```
And rebuild your bundle:
```bash
$ bundle install
```
## Usage
_StrongVersions_ is invoked with a provided executable:
```bash
$ bundle exec strong_versions
```
The executable will output all non-passing gems and will return an exit code of `1` on failure, `0` on success (i.e. all gems passing). This makes _StrongVersions_ suitable for use in a continuous integration pipeline:
Auto-correct is available with the `-a/--auto-correct` option:
```bash
$ bundle exec strong_versions -a
```
### Exclusions
You can tell _StrongVersions_ to ignore any of your gems (e.g. those that don't follow _semantic versioning_) by adding them to the `ignore` section of `.strong_versions.yml` in your project root, e.g.:
```yaml
# .strong_versions.yml
ignore:
- rails
```
Gems in the ignore list will not be updated when using the `-a/--auto-correct` option.
## Contributing
Fork and create a pull request.
Run tests with _RSpec_:
```
$ bin/rspec
```
Check code with _Rubocop_:
```
$ bin/rubocop
```
## License
[MIT License](LICENSE)