Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hoegaarden/asdf-foo

Last synced: 12 days ago
JSON representation

Host: GitHub
URL: https://github.com/hoegaarden/asdf-foo
Owner: hoegaarden
License: mit
Created: 2021-09-10T17:24:44.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-09-10T17:24:45.000Z (over 3 years ago)
Last Synced: 2023-04-09T12:18:16.165Z (over 1 year ago)
Language: Shell
Size: 3.91 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

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. Create repository based on [this template](https://github.com/asdf-vm/asdf-plugin-template/generate)

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](https://asdf-vm.com/#/plugins-create).

>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

    ```

2. Develop!

3. Lint & Format

    ```shell

    ./scripts/shellcheck.bash

    ./scripts/shfmt.bash

    ```

4. PR changes