/asdf-plugin-template

📦 asdf-vm plugin template with GitHub Actions and more!

Primary LanguageShellMIT LicenseMIT

asdf-plugin-template Build Lint

This is an asdf-vm plugin template with CI to run Shellcheck and testing with the asdf test GitHub Action.

Usage

  1. Create repository based on this template
  2. Clone locally and run bash setup.bash.
  3. Adapt your code following the TODO notes on lib/utils.bash.
  4. For developing your plugin further, please read the plugins create section of the docs.

A feature of this plugin-template when hosted on GitHub is the use of release-please, an automated release tool. It leverages Conventional Commit messages to determine semver release type, see the documentation.

Contributing

Contributions welcome!

  1. Install asdf tools 
    asdf plugin add shellcheck https://github.com/luizm/asdf-shellcheck.git
asdf plugin add shfmt https://github.com/luizm/asdf-shfmt.git
asdf install
  2. Develop!
  3. Lint & Format 
    ./scripts/shellcheck.bash
./scripts/shfmt.bash
  4. PR changes