CONTRIBUTING.md

Contribution Guide

Code in Master

Install the dependencies

yarn install

Build the typescript

yarn build

Run the tests ✔️

yarn test

 PASS  src/__test__/installer.spec.ts
  class Installer
    Supported platforms
      Work on "darwin"
        ✓ brewInstall method called on "darwin" platform (3ms)
      Work on "linux"
        ✓ getAptInstall method called on "linux" platform (1ms)
      Work on "win32"
        ✓ chocoInstall method called on "win32" platform
...

Publish to a distribution branch

Actions are run from GitHub repos. We will create a releases branch and only checkin production modules (core in this case).

Comment out node_modules in .gitignore and create a releases/v1 branch

# comment out in distribution branches
# node_modules/
# lib

git checkout -b releases/v1
git commit -a -m "prod dependencies"

npm prune --production
git add node_modules
git commit -a -m "prod dependencies"
git push origin releases/v1

Your action is now published! 🚀

See the versioning documentation

Validate

You can now validate the action by referencing the releases/v1 branch

uses: ts-graphviz/setup-graphviz@releases/v1
with:
  milliseconds: 1000

See the actions tab for runs of this action! 🚀

Usage

After testing you can create a v1 tag to reference the stable and tested action

uses: ts-graphviz/setup-graphviz@v1