From ffa419be75a495843bba37d0820131fc1fa15ec2 Mon Sep 17 00:00:00 2001 From: farhoodetaati Date: Thu, 14 Mar 2024 14:00:08 +0330 Subject: [PATCH] fix: fixes templating issues --- .github/workflows/build.yml | 2 +- README.md | 29 ++++++++++++++--------------- contributing.md | 2 +- lib/utils.bash | 2 +- 4 files changed, 17 insertions(+), 18 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index d58fe52..2f24d0a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -19,4 +19,4 @@ jobs: - name: asdf_plugin_test uses: asdf-vm/actions/plugin-test@v2 with: - command: + command: ys --version diff --git a/README.md b/README.md index 30a471f..721a84b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@
-# asdf- [![Build](https://github.com//asdf-/actions/workflows/build.yml/badge.svg)](https://github.com//asdf-/actions/workflows/build.yml) [![Lint](https://github.com//asdf-/actions/workflows/lint.yml/badge.svg)](https://github.com//asdf-/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) -[]() plugin for the [asdf version manager](https://asdf-vm.com). +[yamlscript]() plugin for the [asdf version manager](https://asdf-vm.com).
# Contents +- [asdf-yamlscript ](#asdf-yamlscript--) +- [Contents](#contents) - [Dependencies](#dependencies) - [Install](#install) - [Contributing](#contributing) @@ -15,35 +17,32 @@ # 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 +asdf plugin add yamlscript # or -asdf plugin add https://github.com//asdf-.git +asdf plugin add yamlscript https://github.com/FeryET/asdf-yamlscript.git ``` -: +yamlscript: ```shell # Show all installable versions -asdf list-all +asdf list-all yamlscript # Install specific version -asdf install latest +asdf install yamlscript latest # Set a version globally (on your ~/.tool-versions file) -asdf global latest +asdf global yamlscript latest -# Now commands are available - +# Now yamlscript commands are available +ys --version ``` Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to @@ -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//asdf-/graphs/contributors)! +[Thanks goes to these contributors](https://github.com/FeryET/asdf-yamlscript/graphs/contributors)! # License -See [LICENSE](LICENSE) © [](https://github.com//) +See [LICENSE](LICENSE) © [Farhood Etaati](https://github.com/FeryET/) diff --git a/contributing.md b/contributing.md index f5b6330..0063c30 100644 --- a/contributing.md +++ b/contributing.md @@ -5,7 +5,7 @@ Testing Locally: ```shell asdf plugin test [--asdf-tool-version ] [--asdf-plugin-gitref ] [test-command*] -asdf plugin test asdf https://github.com//asdf-.git "" +asdf plugin test asdf https://github.com/FeryET/asdf-yamlscript.git "ys --version" ``` Tests are automatically run in GitHub Actions on push and PR. diff --git a/lib/utils.bash b/lib/utils.bash index f364208..6d53ef2 100755 --- a/lib/utils.bash +++ b/lib/utils.bash @@ -13,7 +13,7 @@ fail() { curl_opts=(-fsSL) -# NOTE: You might want to remove this if 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