Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prantlf/shelve-output-action
GitHub action for shelving a build output, usually a binary executable, on each platform to cache, so that it can be unshelved later in the final job, which will produce a release for all platforms.
https://github.com/prantlf/shelve-output-action
actions github github-actions release v vlang
Last synced: about 2 months ago
JSON representation
GitHub action for shelving a build output, usually a binary executable, on each platform to cache, so that it can be unshelved later in the final job, which will produce a release for all platforms.
- Host: GitHub
- URL: https://github.com/prantlf/shelve-output-action
- Owner: prantlf
- License: mit
- Created: 2023-10-18T06:54:40.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-11T16:09:52.000Z (5 months ago)
- Last Synced: 2024-08-11T17:29:08.446Z (5 months ago)
- Topics: actions, github, github-actions, release, v, vlang
- Language: AMPL
- Homepage: https://github.com/marketplace/actions/unshelve-build-output
- Size: 55.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Shelve Build Output
GitHub action for shelving a build output, usually a binary executable, on each platform to cache, so that it can be unshelved later in the final job by [unshelve-output-action], to be able to produce a release for all platforms.
Only platforms Linux, macOS, Windows on the architecture X64 are supported.
## Usage
Pack the binary executable produced with the project name to the project root:
```yml
- uses: prantlf/shelve-output-action@v2
```
Depending on the platform, where the action is running, and the `name` of the executable, it will create one of the following archives and upload it to the cache. For example, for the name `newchanges`:
| OS | Architecture | Archive | Cache Key |
|:--------|:-------------|:-------------------------------|:-------------------------------------|
| Linux | X64 | `newchanges-linux-x64.zip` | `newchanges-linux-x64.zip-{sha}` |
| Linux | ARM64 | `newchanges-linux-arm64.zip` | `newchanges-linux-arm64.zip-{sha}` |
| Linux | RISCV64 | `newchanges-linux-riscv64.zip` | `newchanges-linux-riscv64.zip-{sha}` |
| macOS | ARM64 | `newchanges-macos-arm64.zip` | `newchanges-macos-arm64.zip-{sha}` |
| macOS | X64 | `newchanges-macos-x64.zip` | `newchanges-macos-x64.zip-{sha}` |
| Windows | X64 | `newchanges-windows-x64.zip` | `newchanges-windows-x64.zip-{sha}` |
The name and path to the executable can be specified by `path`. The name prefix of the archive can be specified by `name`, the full file name by `archive`. If not specified, it will be inferred from the project configuration (`v.mod`). The `{sha}` in the cache key is the SHA-1 hash of the current commit.
Use a different name, platform and architecture in the package archive name than the defaults. Specify a custom path to the binary. Work only in specific release branches:
```yml
jobs:
build:
steps:
- uses: actions/checkout@v4
- uses: prantlf/setup-v-action@v2
- run: ...
- uses prantlf/shelve-output-action@v2
with:
archive: vpm-ubuntu-amd64.zip
path: bin/vpm
branches: master v1.x
```
## Inputs
The following parameters can be specified using the `with` object:
### name
Type: `String`
Default: (read from `v.mod`)
The name of the archive without the platform and architecture and without the `.zip` extension. The project name from `v.mod` will be used by default. The name of the archive will be `{name}-{os}-{arch}.zip`, for example: `newchanges-linux-x64.zip`.
### archive
Type: `String`
Default: (read from `v.mod`)
The name of the archive to be created. The project name from `v.mod` will be used by default, if `name` isn't provided. The name of the archive will be `{name}-{os}-{arch}.zip`, for example: `newchanges-linux-x64.zip`.
### os
Type: `String`
Default: (read from `runner.os`)
Override the operating system of the runner. Use if you are cross-compiling. Possible values: `linux`, `macos` and `windows`.
### arch
Type: `String`
Default: (read from `runner.arch`)
Override the architecture of the runner. Use if you are cross-compiling. Possible values: `arm`, `arm64`, `riscv64`, `x64` and `x86`.
### path
Type: `String`
Default: (read from `v.mod`)
The path to the binary file to package, on Windows including the `.exe` extension. The project name from `v.mod` will be used by default, with the file extension according to the platform (`.exe` will be appended on Windows).
### extra
Type: `String`
Paths to additional directories and files to include in the archive together with the binary executable. (No Windows support yet.)
### branches
Type: `String`
Default: `'main master'`
Branches which this action should run for, which are used to publishing releases. Use whitespace for separating the branch names. If you want to use multiple lines in YAML, introduce them with ">-". If you want to allow all branches, set the value to "*".
### enable
Type: `Boolean`
Default: `true`
Can be set to `false` to prevent this action from packing the archive. It's helpful in the pipeline, which will not continue releasing, but only building and testing, and that will be decided in the middle of a job execution.
## Outputs
The following parameters can be accessed by the `github` context:
### archive
Type: `String`
The name of the archive, which was created.
### path
Type: `String`
The path to the file, which was packed.
### cache-key
Type: `String`
The key, which was used to store the created archive to cache.
## License
Copyright (C) 2023-2024 Ferdinand Prantl
Licensed under the [MIT License].
[MIT License]: http://en.wikipedia.org/wiki/MIT_License
[unshelve-output-action]: https://github.com/prantlf/unshelve-output-action