act3

command module
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 27, 2024 License: MIT Imports: 1 Imported by: 0

README

act3

✨ Overview

Glance at the results of the last 3 runs of your Github Actions.

Usage

💾 Installation

homebrew:

brew install dhth/tap/act3

go:

go install github.com/dhth/act3@latest

🛠️ Configuration

Create a config file that looks like the following (act3 will look for this file at ~/.config/act3/act3.yml. by default).

workflows:
- id: ABC
  repo: dhth/outtasync
  name: release
- id: XYZ
  repo: dhth/ecsv
  name: release
  key: key-will-supersede repo/name in the output
- id: EFG
  repo: dhth/cueitup
  name: release

You can find the ID for your workflow as follows:

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR_GH_TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/actions/workflows/<WORKFLOW_FILE>

# use node_id from the response

⚡️ Usage

CLI output
ACT3_GH_ACCESS_TOKEN="<YOUR_GH_TOKEN> \
act3"
HTML output

act3 can also output the results in HTML format.

ACT3_GH_ACCESS_TOKEN="<YOUR_GH_TOKEN> \
    act3" \
    -config-file=./examples/html/act3.yml \
    -format=html \
    -html-template-file=./examples/html/template.html

The resultant HTML page looks like this.

Usage

A sample page generated via act3 is running at https://dhth.github.io/act3, the source code for which is in the examples/html directory.

Acknowledgements

act3 is built using the TUI framework bubbletea.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL