generated from asdf-vm/asdf-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
infiniteregrets
committed
Dec 24, 2023
1 parent
50dff49
commit 3b45b9e
Showing
36 changed files
with
96 additions
and
844 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,6 @@ | ||
version: 2 | ||
updates: | ||
# dependabot for GitHub Actions for this repo | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" | ||
# dependabot for GitHub Actions for the template | ||
- package-ecosystem: "github-actions" | ||
directory: "template/.github/" | ||
schedule: | ||
interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,59 @@ | ||
# 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) | ||
<div align="center"> | ||
|
||
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). | ||
# asdf-mirrord [![Build](https://github.com/infiniteregrets/asdf-mirrord/actions/workflows/build.yml/badge.svg)](https://github.com/infiniteregrets/asdf-mirrord/actions/workflows/build.yml) [![Lint](https://github.com/infiniteregrets/asdf-mirrord/actions/workflows/lint.yml/badge.svg)](https://github.com/infiniteregrets/asdf-mirrord/actions/workflows/lint.yml) | ||
|
||
## Usage | ||
[mirrord](https://mirrord.dev/) plugin for the [asdf version manager](https://asdf-vm.com). | ||
|
||
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). | ||
</div> | ||
|
||
>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). | ||
# Contents | ||
|
||
## Contributing | ||
- [asdf-mirrord](#asdf-mirrord--) | ||
- [Dependencies](#dependencies) | ||
- [Install](#install) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
|
||
Contributions welcome! | ||
# Dependencies | ||
|
||
1. Install `asdf` tools | ||
- `bash`, `curl`, `tar`, and [POSIX utilities](https://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html). | ||
- mirrord has OS specific binaries and are downloaded on the basis `OSTYPE` for determining the OS and `uname` for the architecture. | ||
|
||
```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 | ||
``` | ||
# Install | ||
|
||
1. Develop! | ||
Plugin: | ||
|
||
1. Lint & Format | ||
```shell | ||
asdf plugin add mirrord | ||
# or | ||
asdf plugin add mirrord https://github.com/infiniteregrets/asdf-mirrord.git | ||
``` | ||
|
||
```shell | ||
./scripts/format.bash | ||
./scripts/lint.bash | ||
``` | ||
mirrord: | ||
|
||
1. PR changes | ||
```shell | ||
# Show all installable versions | ||
asdf list-all mirrord | ||
|
||
# Install specific version | ||
asdf install mirrord latest | ||
|
||
# Set a version globally (on your ~/.tool-versions file) | ||
asdf global mirrord latest | ||
|
||
# Now mirrord commands are available | ||
mirrord --version | ||
``` | ||
|
||
Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to | ||
install & manage versions. | ||
|
||
# Contributing | ||
|
||
Contributions of any kind welcome! See the [contributing guide](contributing.md). | ||
|
||
[Thanks goes to these contributors](https://github.com/infiniteregrets/asdf-mirrord/graphs/contributors)! | ||
|
||
# License | ||
|
||
See [LICENSE](LICENSE) © [MetalBear](https://github.com/metalbear-co/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,4 @@ | ||
#!/usr/bin/env bash | ||
|
||
# format this repo | ||
shfmt --language-dialect bash --write \ | ||
setup.bash \ | ||
scripts/*.bash | ||
|
||
# format the template/ | ||
shfmt --language-dialect bash --write \ | ||
template/**/* | ||
./**/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,9 @@ | ||
#!/usr/bin/env bash | ||
|
||
# lint this repo | ||
shellcheck --shell=bash --external-sources \ | ||
setup.bash \ | ||
bin/* --source-path=template/lib/ \ | ||
lib/* \ | ||
scripts/* | ||
|
||
shfmt --language-dialect bash --diff \ | ||
setup.bash \ | ||
scripts/* | ||
|
||
# lint the template/ | ||
shellcheck --shell=bash --external-sources \ | ||
template/bin/* --source-path=template/lib/ \ | ||
template/lib/* \ | ||
template/scripts/* | ||
|
||
shfmt --language-dialect bash --diff \ | ||
template/**/* | ||
./**/* |
Oops, something went wrong.