Git Product home page Git Product logo

vile-git's Introduction

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-git

CI/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_BRANCH

If you are using CircleCI, you can run:

git checkout -f $CIRCLE_BRANCH

Analyzing 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/path

Versioning

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.

  1. Please consider tests and code quality before submitting.
  2. 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

Developing

cd vile-git
npm install
npm test

To run compile task with file watch in the background:

npm run dev

To run tests with coverage:

npm run test-cov

See package.json for other available scripts.

Architecture

  • src is es6+ syntax compiled with Babel
  • lib generated js library
  • test is any test code, written in CoffeeScript
  • .test where coffeescript is generated to

vile-git's People

Contributors

brentlintner avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.