vile-git
v0.5.6
Published
Make use of Git based data including commit messages, author, and sha.
Readme
vile-git
A Vile plugin for making use of Git based data including commit messages, author, and sha.
Features
Creates a vile.SCM issue for the current HEAD commit.
Requirements
Installation
npm i -D vile vile-gitCI/CD Issues
When using more up to date git versions everything should just work.
However, since gift is the git pkg currently being used, the way a repository is
cloned might cause sporadic issues.
For the time being, until a better alternative is used, you may need to run a git command prior to running vile-git.
For example, on Codeship, you would run:
git checkout -f $CI_BRANCHIf you are using CircleCI, you can run:
git checkout -f $CIRCLE_BRANCHAnalyzing Shallow Clones
If you are having further issues, notably with shallow clones, try this:
checkout:
post:
- "[[ ! -s \"$(git rev-parse --git-dir)/shallow\" ]] || git fetch --unshallow"Config
You can specify a custom repo location, else the cwd is used.
git:
config:
repo: ../some/pathVersioning
This project uses Semver.
Licensing
This project is licensed under the MPL-2.0 license.
Any contributions made to this project are made under the current license.
Contributions
Current list of Contributors.
Any contributions are welcome and appreciated!
All you need to do is submit a Pull Request.
- Please consider tests and code quality before submitting.
- Please try to keep commits clean, atomic and well explained (for others).
Issues
Current issue tracker is on GitHub.
Even if you are uncomfortable with code, an issue or question is welcome.
Code Of Conduct
By participating in this project you agree to our Code of Conduct.
Maintainers
- Brent Lintner - @brentlintner
Developing
cd vile-git
npm install
npm testTo run compile task with file watch in the background:
npm run devTo run tests with coverage:
npm run test-covSee package.json for other available scripts.
Architecture
srcis es6+ syntax compiled with Babellibgenerated js librarytestis any test code, written in CoffeeScript.testwhere coffeescript is generated to
