git_validation_task Build Status Gem Version

git_validation_task provides rake integration for the git-validation tool.

Using it

Simply include it in your Rakefile like so:

require "git_validation/task"

GitValidation::Task.new(:"git-validation")

You can pass two options:

  1. from: the inital SHA for the -range flag. If this is not used, then the -range is not used (except for what is described in the CI section of this document).
  2. run: the values to be passed to the run flag. If this is not used, then the -run flag is not used.

Thus, a more complete example would be something like:

require "git_validation/task"

GitValidation::Task.new(:"git-validation") do |t|
  t.from = "74a6c20fc4d3"
end

Or:

require "git_validation/task"

GitValidation::Task.new(:"git-validation") do |t|
  t.from = "74a6c20fc4d3"
  t.run  = "DCO,message_regexp"
end

CI

If the TRAVIS_COMMIT_RANGE environment variable is set, then this value will be used for the -range flag. Thus, any value from the from option will be ignored in this context.

Contributing

Read the CONTRIBUTING.md file.

Changelog

Read the CHANGELOG.md file.

License

This project is based on work I did for the Portus project. I've extracted my code into a gem so it can be also used for other projects that might be interested in this.

Copyright (C) 2020 Miquel Sabat