Skip to content

Commit

Permalink
Update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
taiki-e committed Dec 25, 2022
1 parent ab0e193 commit eea8c31
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,32 @@ Note: In this file, do not use the hard wrap in the middle of a sentence for com

## [Unreleased]

This release implements a mechanism to automatically track the latest version of the tool on our end. ([#27](https://github.com/taiki-e/install-action/pull/27))
Hopefully, this will avoid situations such as "new version of the tool has been released, but the maintainer has not been aware of it for a number of months".
This also makes it easier to add support for new tools.

This release also includes the following improvements:

- Verify SHA256 checksums for downloaded files in all tools installed from GH releases. ([#27](https://github.com/taiki-e/install-action/pull/27))

- Support omitting the patch/minor version in all tools installed from GH releases. ([#27](https://github.com/taiki-e/install-action/pull/27))

For example:

```yaml
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack@0.5
```

You can also omit the minor version if the major version of tool is 1 or greater.

- Support `just`. ([#34](https://github.com/taiki-e/install-action/pull/34))

- Support `dprint`. ([#34](https://github.com/taiki-e/install-action/pull/34))

Note: This release is considered a breaking change because installing on versions not yet recognized by the action or on pre-release versions will no longer work with this release. (They were never officially supported, but they could work before.) Please submit an issue if you need these supports again.

## [1.17.3] - 2022-12-22

- Update `wasmtime@latest` to 4.0.0.
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ GitHub Action for installing development tools (mainly from GitHub Releases).
### Example workflow

```yaml
- uses: taiki-e/install-action@v1
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack
```
Expand All @@ -39,15 +39,24 @@ You can use the shorthand (if you do not need to pin the versions of this action
To install a specific version, use `@version` syntax:

```yaml
- uses: taiki-e/install-action@v1
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack@0.5.24
```

You can also omit patch version.
(You can also omit the minor version if the major version is 1 or greater.)

```yaml
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack@0.5
```

To install multiple tools:

```yaml
- uses: taiki-e/install-action@v1
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack,cargo-minimal-versions
```
Expand Down

0 comments on commit eea8c31

Please sign in to comment.