https://github.com/followtheprocess/actions
A GitHub Actions toolkit for Go!
https://github.com/followtheprocess/actions
Last synced: 9 months ago
JSON representation
A GitHub Actions toolkit for Go!
- Host: GitHub
- URL: https://github.com/followtheprocess/actions
- Owner: FollowTheProcess
- License: mit
- Created: 2025-01-16T19:34:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-14T07:00:13.000Z (10 months ago)
- Last Synced: 2025-08-20T20:44:26.070Z (10 months ago)
- Language: Go
- Size: 159 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# actions
[](https://github.com/FollowTheProcess/actions)
[](https://pkg.go.dev/go.followtheprocess.codes/actions)
[](https://goreportcard.com/report/github.com/FollowTheProcess/actions)
[](https://github.com/FollowTheProcess/actions)
[](https://github.com/FollowTheProcess/actions/actions?query=workflow%3ACI)
[](https://codecov.io/gh/FollowTheProcess/actions)
A GitHub Actions toolkit for Go!
> [!WARNING]
> **actions is in early development and is not yet ready for use**
## Project Description
If you want to write non-trivial GitHub Actions you really only have 2 choices:
- Use NodeJS and [actions/toolkit]
- Use Docker and your language of choice
The latter option suffers because you likely have to implement *a lot* of stuff yourself to do things like:
- Retrieve action inputs and handle them
- Write to `$GITHUB_OUTPUT` and/or `$GITHUB_STEP_SUMMARY`
- Writing [Workflow Commands] to provide feedback in the logs
- Platform independent filepath manipulations
- Executing external commands
- Responding to `${{ runner.debug }}` for writing debug logs
- Source file annotations
- Grouping logs
- And more...
And the former means you have to write Javascript... 👀
### Go and GitHub Actions
I put it to you that Go could be an *excellent* language for writing GitHub actions:
- It's fast and memory efficient (saving 💵 on private GitHub runner costs)
- Excellent support for concurrency and asynchronous execution
- A powerful, batteries included standard library with more or less everything an action author needs out of the box
- It plays excellently with Docker, leading to tiny, very efficient images
- It's simple and safe
- General purpose enough to be able to everything an action might want to do
> [!TIP]
> You don't even need Docker! You could just `GOOS=linux GOARCH=amd64 go build ` and fetch the binary
> (e.g. from a GitHub release) inside a [composite action] and pass the inputs as command line arguments/flags!
The only thing missing is a toolkit providing sensible, common functionality for GitHub Action authors... That's where `actions` comes in!
## Installation
```shell
go get go.followtheprocess.codes/actions@latest
```
## Quickstart
### Credits
This package was created with [copier] and the [FollowTheProcess/go_copier] project template.
[copier]: https://copier.readthedocs.io/en/stable/
[FollowTheProcess/go_copier]: https://github.com/FollowTheProcess/go_copier
[actions/toolkit]: https://github.com/actions/toolkit
[Workflow Commands]: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions
[composite action]: https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action