marque v1.0.1

Marque - Tag Versioning Helper

This open-source library helps in fetching and versioning the tags of your GIT repositories and Google Cloud Platform images.

It can be used either inside a node repository or as a CLI tool.

Requirements

• Node 7.0.0 or later
• Git or gcloud as per the usage

Installation

It can be installed locally or globally or both as per different use cases. Local installation is preferred if this library will be used inside a node module. Global installation is preferred if it will be used as a CLI tool.

For Local Repository

# via npm
npm install marque

# via yarn
yarn add marque

Global Installation

# via npm
npm install -g marque

# via yarn
yarn global add marque

Usage

As per the use case, this library can be used in multiple ways:

Node Module

It can be integrated with any Node.js service. It will return the incremented tag version based on the configuration.

const marque = require('marque');

marque.increment({ type: 'git', version: 'minor' })

Options:

• type: Usage type i.e. git or gcloud
• version: Version type to increment i.e. major, minor or patch
• imageName: Image or resource name on gcloud. (Only for GCP)
• limit: Number of previous tags to fetch from gcloud to evaluate the latest tag. Normally this won't be required. (Only for GCP)

Command line interface

It can be used in your terminal with interactive CLI just using the command:

marque

It can also be used directly using:

# GIT

marque git <version>

marque <version> # Can omit git as it's default

# Google Cloud Platform

marque gcloud <version> <image-name>

marque gcloud <version> <image-name> --limit=50 # with limit

Tools like Jenkins

newTag=$(marque gcloud <version> <image-name>)

if [[ $newTag == *"Error"* ]]; then
  exit 0
fi

Third-party Resources and Credits

Refer third-party-attributions.txt

Authors

• Punit Gupta
• Gaurav Nanda

Contributing

Please go through our contributing guidelines

Code of Conduct

Code of Conduct

License

MIT