https://github.com/asdf-vm/asdf-plugin-template

📦 asdf-vm plugin template with GitHub Actions and more!
https://github.com/asdf-vm/asdf-plugin-template

asdf asdf-plugin asdf-vm template

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/asdf-vm/asdf-plugin-template
• Owner: asdf-vm
• License: mit
• Created: 2020-03-05T21:42:29.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-01T01:56:16.000Z (10 months ago)
• Last Synced: 2024-12-22T04:09:20.323Z (4 months ago)
• Topics: asdf, asdf-plugin, asdf-vm, template
• Language: Shell
• Homepage: https://asdf-vm.com
• Size: 76.2 KB
• Stars: 112
• Watchers: 8
• Forks: 53
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - asdf-vm/asdf-plugin-template - 📦 asdf-vm plugin template with GitHub Actions and more! (Shell)

README

        
# asdf-plugin-template [![Build](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/build.yml/badge.svg)](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/build.yml) [![Lint](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/lint.yml/badge.svg)](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/lint.yml)

This is an [asdf-vm plugin](https://asdf-vm.com/#/plugins-create) template with CI to run [Shellcheck](https://github.com/koalaman/shellcheck) and testing with the [asdf test GitHub Action](https://github.com/asdf-vm/actions).

## Usage

1. [Generate](https://github.com/asdf-vm/asdf-plugin-template/generate) a new repository based on this template.

1. Clone it and run `bash setup.bash`.

1. Force push to your repo: `git push --force-with-lease`.

1. Adapt your code at the TODO markers. To find the markers: `git grep TODO`.

1. To develop your plugin further, please read [the plugins create section of the docs](https://asdf-vm.com/plugins/create.html).

>A feature of this plugin-template when hosted on GitHub is the use of [release-please](https://github.com/googleapis/release-please), an automated release tool. It leverages [Conventional Commit messages](https://www.conventionalcommits.org/) to determine semver release type, see the [documentation](https://github.com/googleapis/release-please).

## Contributing

Contributions welcome!

1. Install `asdf` tools

    ```shell

    asdf plugin add shellcheck https://github.com/luizm/asdf-shellcheck.git

    asdf plugin add shfmt https://github.com/luizm/asdf-shfmt.git

    asdf install

    ```

1. Develop!

1. Lint & Format

    ```shell

    ./scripts/format.bash

    ./scripts/lint.bash

    ```

1. PR changes