go-action

Go Action

GitHub Actions Toolkit for Go

Goals

The goal is simple: provide a nice developer experience to people who want to author GitHub Actions using Go while exploring how that experience can be improved.

Features

• Functions for every workflow command (ex.: action.GetInput(), action.SetInput())
• Easy access to the GitHub Context (ex.: action.Context.Token, action.Context.Ref)
• Ready-to-use GitHub REST client (action.REST)
• Typed events (action.GetEvent())
• Experimental. Automatic bindings of inputs and outputs (see this example)

This project is under active development and stability isn't guaranteed, use at your own discretion.

Installation

$ go get github.com/underopsco/go-action

Examples

Check the examples directory for a list of examples. You can also see them being used in the examples.yml workflow (check runs).

Documentation

Documentation is available on pkg.go.dev.

Go Action in the Wild

• conventional-commits-action: Validate a Pull Request title and commit messages against Conventional Commits guidelines

Acknowledgements

These are packages we either use or projects we are inspired by, and to whom we want to express our gratitude:

• google/go-github: Go library for accessing the GitHub API
• sethvargo/go-githubactions: Go SDK for GitHub Actions

Contributing

We appreciate every contribution, thanks for considering it!

• Open an issue if you have a problem or found a bug
• Open a Pull Request if you have a suggestion, improvement or bug fix

License

This project is released under the MIT License.