Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prantlf/unshelve-output-action

GitHub action for unshelving a build output from the cache, where it was shelved by shelve-output-action, to be able to upload it as artefacts for a new release.
https://github.com/prantlf/unshelve-output-action

actions github github-actions release v vlang

Last synced: about 1 month ago
JSON representation

GitHub action for unshelving a build output from the cache, where it was shelved by shelve-output-action, to be able to upload it as artefacts for a new release.

Host: GitHub
URL: https://github.com/prantlf/unshelve-output-action
Owner: prantlf
License: mit
Created: 2023-10-18T13:57:24.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2024-08-11T16:51:07.000Z (5 months ago)
Last Synced: 2024-08-11T17:45:26.208Z (5 months ago)
Topics: actions, github, github-actions, release, v, vlang
Language: AMPL
Homepage: https://github.com/marketplace/actions/unshelve-build-output
Size: 47.9 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

# Unshelve Build Output

GitHub action for unshelving a build output from the cache, where it was shelved by [shelve-output-action], to be able to upload it as artefacts for a new release.

Only platforms Linux, macOS, Windows on the architecture X64 are supported.

## Usage

Download archives with binary executables produced on each platform and shelved earlier to the project root and delete the shelf from the cache:

```yml
- uses: prantlf/unshelve-output-action@v5
```

Depending on the `name` of the executable, it will download the following archives from 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 prefix of the archives can be specified by `name`. 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 prefix than the default in the package archive name. Work only in specific release branches. Prevent deletion the shelf from the cache. Ignore the archive for macOS ARM64:

```yml
jobs:
release:
steps:
...
- uses: prantlf/unshelve-output-action@v5
with:
name: vpm
branches: master v1.x
discard-shelf: false
include-macos-arm64: false
```

## 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 expected names of the archives will be `{name}-{os}-{arch}.zip`, for example: `newchanges-linux-x64.zip`.

### 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