forked from asdf-vm/asdf
-
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.
fix: lint scripts for local and CI (asdf-vm#961)
- Loading branch information
Showing
4 changed files
with
37 additions
and
21 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,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 |
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 |
---|---|---|
@@ -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/* |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
#!/usr/bin/env bash | ||
|
||
exec shfmt -d . |