Skip to content

Commit

Permalink
fix: fixes templating issues
Browse files Browse the repository at this point in the history
  • Loading branch information
FeryET committed Mar 14, 2024
1 parent ec73d6a commit ffa419b
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ jobs:
- name: asdf_plugin_test
uses: asdf-vm/actions/plugin-test@v2
with:
command: <TOOL CHECK>
command: ys --version
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,48 @@
<div align="center">

# asdf-<YOUR TOOL> [![Build](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/actions/workflows/build.yml/badge.svg)](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/actions/workflows/build.yml) [![Lint](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/actions/workflows/lint.yml/badge.svg)](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/actions/workflows/lint.yml)
# asdf-yamlscript [![Build](https://github.com/FeryET/asdf-yamlscript/actions/workflows/build.yml/badge.svg)](https://github.com/FeryET/asdf-yamlscript/actions/workflows/build.yml) [![Lint](https://github.com/FeryET/asdf-yamlscript/actions/workflows/lint.yml/badge.svg)](https://github.com/FeryET/asdf-yamlscript/actions/workflows/lint.yml)

[<YOUR TOOL>](<TOOL HOMEPAGE>) plugin for the [asdf version manager](https://asdf-vm.com).
[yamlscript](<TOOL HOMEPAGE>) plugin for the [asdf version manager](https://asdf-vm.com).

</div>

# Contents

- [asdf-yamlscript ](#asdf-yamlscript--)
- [Contents](#contents)
- [Dependencies](#dependencies)
- [Install](#install)
- [Contributing](#contributing)
- [License](#license)

# Dependencies

**TODO: adapt this section**

- `bash`, `curl`, `tar`, and [POSIX utilities](https://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html).
- `SOME_ENV_VAR`: set this environment variable in your shell config to load the correct version of tool x.

# Install

Plugin:

```shell
asdf plugin add <YOUR TOOL>
asdf plugin add yamlscript
# or
asdf plugin add <YOUR TOOL> https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>.git
asdf plugin add yamlscript https://github.com/FeryET/asdf-yamlscript.git
```

<YOUR TOOL>:
yamlscript:

```shell
# Show all installable versions
asdf list-all <YOUR TOOL>
asdf list-all yamlscript

# Install specific version
asdf install <YOUR TOOL> latest
asdf install yamlscript latest

# Set a version globally (on your ~/.tool-versions file)
asdf global <YOUR TOOL> latest
asdf global yamlscript latest

# Now <YOUR TOOL> commands are available
<TOOL CHECK>
# Now yamlscript commands are available
ys --version
```

Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
Expand All @@ -53,8 +52,8 @@ install & manage versions.

Contributions of any kind welcome! See the [contributing guide](contributing.md).

[Thanks goes to these contributors](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/graphs/contributors)!
[Thanks goes to these contributors](https://github.com/FeryET/asdf-yamlscript/graphs/contributors)!

# License

See [LICENSE](LICENSE) © [<YOUR NAME>](https://github.com/<YOUR GITHUB USERNAME>/)
See [LICENSE](LICENSE) © [Farhood Etaati](https://github.com/FeryET/)
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Testing Locally:
```shell
asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]

asdf plugin test asdf https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>.git "<TOOL CHECK>"
asdf plugin test asdf https://github.com/FeryET/asdf-yamlscript.git "ys --version"
```

Tests are automatically run in GitHub Actions on push and PR.
2 changes: 1 addition & 1 deletion lib/utils.bash
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ fail() {

curl_opts=(-fsSL)

# NOTE: You might want to remove this if <YOUR TOOL> is not hosted on GitHub releases.
# NOTE: You might want to remove this if yamlscript is not hosted on GitHub releases.
if [ -n "${GITHUB_API_TOKEN:-}" ]; then
curl_opts=("${curl_opts[@]}" -H "Authorization: token $GITHUB_API_TOKEN")
fi
Expand Down

0 comments on commit ffa419b

Please sign in to comment.