https://github.com/ton-blockchain/setup-acton
Set up your GitHub Actions workflow with a specific version of Acton
https://github.com/ton-blockchain/setup-acton
actions acton github-actions ton ton-blockchain
Last synced: 20 days ago
JSON representation
Set up your GitHub Actions workflow with a specific version of Acton
- Host: GitHub
- URL: https://github.com/ton-blockchain/setup-acton
- Owner: ton-blockchain
- License: mit
- Created: 2026-01-03T17:21:48.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2026-05-11T07:43:28.000Z (about 1 month ago)
- Last Synced: 2026-05-11T09:22:42.476Z (about 1 month ago)
- Topics: actions, acton, github-actions, ton, ton-blockchain
- Language: TypeScript
- Homepage:
- Size: 1.13 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# setup-acton
This action sets up [Acton](https://github.com/ton-blockchain/acton) for use in GitHub Actions by:
- Downloading a requested Acton release archive and adding `acton` to the `PATH`
- Restoring and saving the installed `acton` binary with the GitHub Actions cache
- Exposing the installed binary path, detected Acton version, and cache status as outputs
## Contents
- [Usage](#usage)
- [Install Acton](#install-acton)
- [Using outputs](#using-outputs)
- [Inputs](#inputs)
- [Outputs](#outputs)
- [Version resolution](#version-resolution)
- [Caching](#caching)
- [Supported targets](#supported-targets)
- [Recommended permissions](#recommended-permissions)
- [Checksum verification](#checksum-verification)
## Usage
### Install Acton
```yaml
steps:
- name: Setup Acton
uses: ton-blockchain/setup-acton@2d38fd579e1bf8753a3e0cff9ad695612b98a676 # v1.0.0
```
If you do not specify a version, this action reads `Acton.toml` from `working-directory` first and falls back to the
latest Acton release when no project version is configured.
See [action.yml](action.yml).
```yaml
- name: Setup Acton
uses: ton-blockchain/setup-acton@2d38fd579e1bf8753a3e0cff9ad695612b98a676 # v1.0.0
with:
# Acton version to install.
# Supported values include 'latest', a release tag such as 'v1.0.0',
# a bare semantic version such as '1.0.0', or 'trunk'.
# Defaults to the version in Acton.toml or 'latest'.
version: '1.0.0'
# Target architecture. Auto-detected from the runner if not specified.
# Supported values: x86_64, aarch64.
architecture: 'x86_64'
# Target platform. Auto-detected from the runner if not specified.
# Supported values: linux, apple, windows.
platform: 'linux'
# Working directory for the Acton project. Defaults to the GitHub workspace.
working-directory: ${{ github.workspace }}
# Restore and save the resolved Acton binary with the GitHub Actions cache.
save-cache: true
# GitHub token for authenticated release metadata and asset downloads.
github-token: ${{ github.token }}
```
### Using outputs
```yaml
steps:
- name: Setup Acton
uses: ton-blockchain/setup-acton@2d38fd579e1bf8753a3e0cff9ad695612b98a676 # v1.0.0
id: setup-acton
with:
version: '1.0.0'
- run: |
echo "Acton path: ${{ steps.setup-acton.outputs.acton-path }}"
echo "Acton version: ${{ steps.setup-acton.outputs.acton-version }}"
echo "Cache hit: ${{ steps.setup-acton.outputs.cache-hit }}"
```
## Inputs
| Name | Required | Default | Description |
|---------------------|----------|---------------------------|---------------------------------------------------------------------------|
| `version` | No | `Acton.toml` or `latest` | Acton version to install. See [Version resolution](#version-resolution). |
| `architecture` | No | Runner architecture | Target architecture. See [Supported targets](#supported-targets). |
| `platform` | No | Runner platform | Target platform. See [Supported targets](#supported-targets). |
| `working-directory` | No | `${{ github.workspace }}` | Working directory for the Acton project. |
| `save-cache` | No | `true` | Restore and save the resolved Acton binary with the GitHub Actions cache. |
| `github-token` | No | `${{ github.token }}` | GitHub token used to fetch release metadata and release assets. |
## Outputs
| Name | Description |
|-----------------|--------------------------------------------------------|
| `acton-path` | Full path to the installed `acton` binary. |
| `acton-version` | Installed Acton version parsed from `acton --version`. |
| `cache-hit` | Whether the Acton binary was restored from cache. |
> **Note**: `acton-version` returns `unknown` if the version cannot be detected.
## Version resolution
The action resolves the Acton version in this order:
- **`version` input** - If `version` is set, the action uses it. If the value is `latest`, the action fetches the latest
GitHub release from `ton-blockchain/acton`.
- **`Acton.toml`** - If `version` is omitted, the action reads `[toolchain].acton` from `Acton.toml` in
`working-directory`.
- **Latest release** - If no version is configured, the action gets the latest version from `ton-blockchain/acton`.
`Acton.toml` example:
```toml
[toolchain]
acton = "0.3.2"
```
The resolved version supports the following syntax:
- **Release tag** - If `version` starts with `v`, the value is used as the release tag, for example `v1.0.0`.
- **Bare semantic version** - If `version` is a plain semantic version such as `1.0.0`, it is normalized to `v1.0.0`.
- **Trunk** - `trunk` installs the moving `trunk` release. Do **not** use `trunk` in production workflows.
- **Custom release tag** - Any other value is passed through unchanged and must match an existing Acton release tag.
After resolving the release tag, the action downloads the matching archive for the selected platform and architecture.
> **Warning**: We recommend pinning a versioned Acton release in `version` or `Acton.toml` for reproducible workflows.
> Use `latest` or other non-version tags only when you explicitly want the workflow to track a moving release.
> **Note**: It is recommended to wrap version values in single quotation marks to avoid YAML parsing surprises:
>
> ```yaml
> version: '1.0.0'
> ```
## Caching
By default, this action restores and saves the resolved Acton binary with the GitHub Actions cache. The cache key
includes the binary name, resolved version, platform target, and architecture. The cache is saved by the action's post
step only when the job succeeds.
When the same cache key is restored, the post-step skips saving the cache again.
> **Note**: When the explicit `version` input is `trunk`, the post-step skips saving the cache because `trunk` is a
> moving target.
Disable caching with:
```yaml
with:
save-cache: false
```
## Supported targets
The action can resolve the following platform targets:
| Platform input | Artifact target |
|----------------|---------------------|
| `linux` | `unknown-linux-gnu` |
| `apple` | `apple-darwin` |
| `windows` | `pc-windows-msvc` |
The action can resolve the following architecture targets:
| Architecture input | Artifact architecture |
|--------------------|-----------------------|
| `x86_64` | `x86_64` |
| `aarch64` | `aarch64` |
## Recommended permissions
When using the `setup-acton` action in your GitHub Actions workflow, it is recommended to set the following permissions:
```yaml
permissions:
contents: read # access release metadata and release assets
```
## Checksum verification
The downloaded Acton archive must match the expected `SHA-256` checksum. If the checksum does not match, the action
fails before extracting or adding `acton` to `PATH`.
```bash
bun ci
bun run all
```
`dist/setup/index.js` is committed because GitHub Actions runs the bundled file declared in [action.yml](action.yml).
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup, pull request expectations, and release asset maintenance notes.
## Security
Please report suspected vulnerabilities privately. See [SECURITY.md](SECURITY.md).
## Code of Conduct
This project follows the [Acton Code of Conduct](CODE_OF_CONDUCT.md).
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE).