houseabsolute/Release Rust Project Binaries as GitHub Releases
This action provides tooling for releasing binaries from Rust projects as GitHub releases.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| executable-name | The name of the executable. In most cases, this is just the name of your project, like `cross` or `mise`. This is required. | yes | — |
| release-tag-prefix | The prefix for release tags. The default is "v", so that tags like "v1.2.3" trigger a release. | — | v |
| target | The rust target name, like "x86_64-unknown-linux-gnu". This is used to find the output of `cargo build`. If this isn't provided, then this action will look for the build output under `target/release`, instead of something like `target/x86_64-unknown-linux-gnu/release`. Either this input or the `archive-name` input must be provided. | — | — |
| archive-name | The name of the archive file to produce. This will contain the executable and any additional files specified in the `files-to-package` input, if any. If this isn't given, then one will be created based, starting with the `executable-name` and followed by elements from the `target` input. Either this input or the `target` input must be provided. | — | — |
| extra-files | A newline separated list of additional files or globs to include in the archive files for a release. Defaults to the file specified by the `changes-file` input and any file matching `README*` in the project root. If you _do_ specify any files, then you will need to also list the changes file and README explicitly if you want them to be included. | — | — |
| changes-file | The name of the file that contains the changelog for this project. This will be used to generate a description for the GitHub Release. The default is `Changes.md`. | — | Changes.md |
| working-directory | The current working directory in which the Rust project is. It defaults to "." so the current working directory. | — | . |
| action-gh-release-parameters | A JSON string containing parameters to pass to `softprops/action-gh-release@v2`. You can use the `toJSON()` function in your action to make passing this easier. | — | {} |
| _force-release-for-testing | This exists to let me test the release parts of this action. | — | — |
Outputs
| name | description |
|---|---|
| artifact-id | This is the ID of the artifact created by this action. |
| artifact-url | This is the URL of the artifact created by this action. |