Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: lint scripts for local and CI #961

Merged
merged 3 commits into from May 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 2 additions & 12 deletions .github/workflows/lint.yml
Expand Up @@ -17,17 +17,7 @@ jobs:
uses: asdf-vm/actions/install@v1

- name: Run ShellCheck
run: |
shellcheck -s bash -x \
asdf.sh \
release/tag.sh \
bin/asdf \
bin/private/asdf-exec \
lib/utils.bash \
lib/commands/*.bash \
completions/*.bash \
test/test_helpers.bash \
test/fixtures/dummy_plugin/bin/*
run: scripts/shellcheck.bash

shellfmt:
runs-on: ubuntu-latest
Expand All @@ -42,4 +32,4 @@ jobs:
run: shfmt -f .

- name: Run shfmt
run: shfmt -d .
run: scripts/shfmt.bash
28 changes: 19 additions & 9 deletions release/README.md
@@ -1,19 +1,29 @@
# Release README

If you are a user you can ignore everything in this directory. This directory contains documentation and scripts for preparing and tagging new versions of asdf and is only used by asdf maintainers.
If you are a user you can ignore everything in this directory. This directory
contains documentation and scripts for preparing and tagging new versions of
asdf and is only used by asdf maintainers.

## Tagging Release Candidates

To tag release candidates

1. Update the CHANGELOG. Make sure it contains an entry for the version you are tagging as well as a dev version things that come after the tag (e.g. a heading with the format `<next-version>-dev`)
2. Run the tests and the linter - `bats test`
3. Run the release script. The new version must be in the format `0.0.0-rc0`. For example: `release/tag.sh 0.0.0-rc0`
4. If the release script succeeds, push to GitHub. Make sure to use the correct remote to push to the official repository
1. Update the CHANGELOG. Make sure it contains an entry for the version you are
tagging as well as a dev version things that come after the tag (e.g. a heading
with the format `<next-version>-dev`).
2. Run the tests, linter and format check - `bats test`, `./scripts/shellcheck.bash` and `./scripts/shfmt.bash`.
3. Run the release script. The new version must be in the format `0.0.0-rc0`.
For example: `release/tag.sh 0.0.0-rc0`.
4. If the release script succeeds, push to GitHub. Make sure to use the correct
remote to push to the official repository

## Tagging Releases

1. Update the CHANGELOG. Make sure it contains an entry for the version you are tagging as well as a dev version things that come after the tag (e.g. a heading with the format `<next-version>-dev`)
2. Run the tests and the linter - `bats test`
3. Run the release script. The new version must be in the format `0.0.0`. For example: `release/tag.sh 0.0.0`
4. If the release script succeeds, push to GitHub. Make sure to use the correct remote to push to the official repository
1. Update the CHANGELOG. Make sure it contains an entry for the version you are
tagging as well as a dev version things that come after the tag (e.g. a heading
with the format `<next-version>-dev`).
2. Run the tests, linter and format check - `bats test`, `./scripts/shellcheck.bash` and `./scripts/shfmt.bash`.
3. Run the release script. The new version must be in the format `0.0.0`. For
example: `release/tag.sh 0.0.0`.
4. If the release script succeeds, push to GitHub. Make sure to use the correct
remote to push to the official repository
13 changes: 13 additions & 0 deletions scripts/shellcheck.bash
@@ -0,0 +1,13 @@
#!/usr/bin/env bash

exec shellcheck -s bash -x \
asdf.sh \
completions/*.bash \
bin/asdf \
bin/private/asdf-exec \
lib/utils.bash \
lib/commands/*.bash \
release/tag.sh \
scripts/*.bash \
test/test_helpers.bash \
test/fixtures/dummy_plugin/bin/*
3 changes: 3 additions & 0 deletions scripts/shfmt.bash
@@ -0,0 +1,3 @@
#!/usr/bin/env bash

exec shfmt -d .