VERSION:1.0.1
Published 25 days ago by @cto.ai
$ ops run @cto.ai/
github-actions

CTO Banner

GitHub Actions Manager

The GitHub Actions Op utilizes Git and GitHub to manage GitHub Actions from the commmand line.

Requirements

To run this or any other Op, install the Ops Platform.

Find information about how to run and build Ops via the Ops Platform Documentation

This Op also requires API Key for GitHub and an URL of a GitHub repository that has GitHub Actions already configured.

  • To create one, refer to the instructions here
  • Set GitHub Access Token to GITHUB_TOKEN in team secrets by running ops secrets:set
  • Once you have registered your GitHub personal access token in secrets, the Op will automatically fetch the key from your team's secret storage!

You would also require a GitHub repository that has a GitHub action workflow already set up.

For details on how to set up a GitHub action please visit here

Usage

In CLI:

ops run @cto.ai/github-actions

In Slack:

/ops run cto.ai/github-actions

Running the Op will guide you through a series of prompts to setup and start managing GitHub Actions.

Features

  • Workflow Management
    • Re-name workflows and update workflow triggers
    • Review workflow run logs and re-run cancelled workflow runs
  • Secrets Management
    • List and review registered secrets in repository
    • Add and delete secrets for repository

Notes

  • The operation to re-run a workflow run is only limited to workflow runs that have a 'cancelled' state
  • The maximum number of secrets a repository is able to have is 100. Each secret must be less than 64 KB in size. For storing secrets larger than 64 KB refer to GitHub's documentation here: Limits for GitHub Secrets
  • There are many more trigger events available for workflows. As this Op is a proof of concept, only basic triggers are used. A deeper dive into the available triggers for workflows can be found here: GitHub Actions Triggers

Testing

Run npm test

Debugging Issues

When submitting issues or requesting help, be sure to also include the version information. To get your ops version run:

ops -v

Contributing

See the contributing docs for more information

Contributors


Timothy Wan


Calvin Holloway


Mario Mejia

License

MIT