Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wdzeng/action-of-action
A GitHub action for building GitHub actions.
https://github.com/wdzeng/action-of-action
Last synced: 14 days ago
JSON representation
A GitHub action for building GitHub actions.
- Host: GitHub
- URL: https://github.com/wdzeng/action-of-action
- Owner: wdzeng
- License: mit
- Created: 2022-06-12T15:09:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T13:58:25.000Z (3 months ago)
- Last Synced: 2024-08-16T15:19:32.358Z (3 months ago)
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Action of Action
A GitHub action for building GitHub actions written in TypeScript. It does the following things:
1. Downloads the source action project.
2. Runs `pnpm build` to build the source action project. This should transpiles the TypeScript action to JavaScript.
3. Retrieves the transpiled files under a directory (e.g. `dist/`) and pushes them to remote destination branch (e.g.
`origin/release`).
4. Adds and pushes three version tags `vX`, `vX.X`, and `vX.X.X` to remote destination branch, and a source tag
`src-X.X.X` to remote source (`origin/HEAD`). For pre-releases, only one version tag `vX.X.X-alpha|beta-X` is pushed
to remote destination branch.
## Prerequisites
- The project can be installed using pnpm at least v9.7.0.
- The TypeScript action can be transpiled into JavaScript by `build` command defined in `scripts` field in package.json.
- The project version is specified in `version` field in package.json.
- The project version is a semver. For pre-releases, only `alpha` and `beta` are allowed.
## Inputs
All inputs are optional.
- github-token: the GitHub token to use; default to `${{ github.token }}`
- dist-dir: the directory under which files are to be pushed; default to `./dist`
- remote-name: remote name to download and push the source and destination action; default to `remote`
- dist-branch: target branch to push the built action; default to `release`
- user-name: commit user for the build; default to `bot`
- user-email: commit user email for the build; default to `[email protected]`
## Usage
```yml
name: Build
on:
push:
branches:
- main
jobs:
build:
name: Build action
runs-on: ubuntu-latest
steps:
- uses: wdzeng/action-of-action@v4
```
You don't need to run `actions/checkout`. This action does that for you.