@versett/versett-scripts v0.16.0

versett-scripts

Collection of scripts that are useful for all V// projects.

Usage

versett-scripts runs automatically based on git hooks and CI configuration, provided you add it as a dependency in your project and configure it according to the instructions below.

Whenever you commit or push code to your project, versett-scripts will run its validations in order to enforce good practices on branch names and commit messages.

Furthermore, versett-scripts adds support for automated changelog, release, and npmjs publishing.

Installation

1. Run yarn add @versett/versett-scripts --dev
2. In order to enable the git hook commands, you have to add husky configuration to your package.json. There are currently four commands supported by versett-scripts. Here's a configuration example containing all four, which can be added to your package.json's root:

"husky": {
  "hooks": {
    "commit-msg": "versett-scripts commitmsg ${HUSKY_GIT_PARAMS}",
    "pre-commit": "versett-scripts precommit",
    "prepare-commit-msg": "versett-scripts preparecommitmsg ${HUSKY_GIT_PARAMS}",
    "pre-push": "versett-scripts prepush"
  }
}

This will ensure that the versett-scripts commands run whenever you do a commit or push in the target repository.

3. For the precommit hook, you also need some minimal lint-staged config. You should have it match the characteristics of your project as to what kind of linting is going to be done. Here's an example, which can be added to your package.json's root:

"lint-staged": {
  "*.{js,json,css,md,ts,tsx}": ["prettier --write", "git add"]
}

4. For the release command, you also need to set the following in your package.json's root:

"version": "0.0.0-semantically-released",
"scripts": {
  "release": "yarn && versett-scripts release"
},
"release": {
  "getLastRelease": "last-release-git"
}

5. Append versett-scripts test to your CI test script:

"scripts": {
  "test:ci": "... && versett-scripts test"
}

• If you want to publish your package to npm, you can add the --npm-publish flag to the release command:

"release": "yarn && versett-scripts release --npm-publish"

• Your CI server should be configured to run release on new commits to master.

• In order to get release to work on CI servers, make sure you set the GH_TOKEN and NPM_TOKEN environment variables. They should contain the tokens issued by your Github and NPM accounts.

• For a commit to show up on the automated changelog, it has to have a template message, as defined in conventional changelog. Every pull request needs to have at least one template commit.

• If you are using Circle CI, you should add the following to the package.json

"release": {
  "verifyConditions": "condition-circle"
}

Commands and features

For the following, let's assume that you enabled all commands as described in the Installation section.

• versett-scripts will use git hooks to perform checks on all commits to your repo. Whenever a commit is made, the following commands will be ran, in order: prepare-commit-msg, commit-msg, pre-commit. If any of the check fails, nothing will be committed.

  • prepare-commit-msg: Automatically appends the issue ID based on the branch name ((#ISSUEID)) to your commit message. If the branch name doesn't contain an issue ID (e.g. master), prepare-commit-msg won't append anything. This might imply that other checks will fail.

  • commit-msg: It checks whether the commit message is a template one. If it is, it's enforced to follow the pattern ((feat|fix|perf): COMMITMESSAGE (#ISSUEID)).

  • pre-commit: - Automatically applies Prettier to the staged files, according to the lint-staged configuration on your package.json.

• versett-scripts will validate your branch name before any push by using the pre-push hook. Every branch name has to follow the pattern (feature|bugfix|hotfix)/ISSUEID-ISSUE-DESCRIPTION. If the check fails, nothing gets pushed.

  • Note: commit and push validations can be skipped by using a --no-verify flag in your git command. However, the --no-verify flag defeats the purpose of enforcing good practices and is meant for exceptional situations only. Here's an example:

  git add my-file
  git commit -m "My commit message (#123)" --no-verify
  git push --no-verify

• versett-scripts will test your branch's commit messages using the test command to make sure each branch contains at least one semantic commit before getting merged.

• versett-scripts will be able to publish your package to npmjs, by means of the release command. The release command:
  • Automatically calculates the new version number by using get-latest-release and the new commits that follow the template.
  • Pushes a tag with the version number to Github.
  • Publishes a Github release containing the changelog based on your template commits.

Development

To get started on development run these commands:

nvm use
yarn

For testing purposes you can use yarn link (or npm link):

cd versett-scripts
yarn link

then

cd my-project
yarn link @versett/versett-scripts

After that, a symbolic link is added to node_modules of the project directory.

Contributing

Please read the contributing guide for details on our process for submitting pull requests.

Versioning

Versioning is done automatically by versett-scripts when a branch is merged with master and our CI/CD runs.

Need help?

Open an issue, we're happy to chat!