actions-toolkit

Some improvements to the Toolkit#command method:

• Run multiple times for multiple matches
• Pass the match array to the handler
• Improved docs

What’s Changed

• Improvements to Toolkit#command, including better command matching and documentation.
• Mock process.on() in tests (#60) @JasonEtco

This is the first beta release containing a new method, Toolkit#command being worked on in #53. Still missing docs, but this beta release should help to test it out in real Actions.

New feature

tools.log

A slightly customized instance of Signale, a great logging utility. You can use it in two ways: as tools.log(), or by picking the particular method.

tools.log('Logging something amazing!')
tools.log.info('Here is some information!')

Signale will output your logs to the Actions UI with some icons to help identify your logs:

I'm interested in your feedback on this feature!

What’s Changed

• Fix release workflow (#47) @JasonEtco
• Use external validate-semver-release action (#48) @JasonEtco
• Add Signale logger (#45) @JasonEtco

What’s Changed

Some additional changes to the Signale PR #45 that allow for a callable tools.log method:

tools.log('Hello!')
tools.log.info('Wow!')

New feature

This minor release (1.5.0) will include support for a logger - see #45 for the implementation! It's still missing documentation, hence the beta prerelease. I wanted to try it out in some real actions first!

Some basic docs:

tools.log.METHOD

So:

tools.log.info('Omg wow!')

What’s Changed

The biggest change in this release is #44, which changes the behavior added in #36 to be a lot less aggressive. Thanks @banyan ❤️

• Update validate release action (#42) @JasonEtco
• Return neutral if skipped (#44) @banyan

New features

tools.exit

A collection of methods to end the action's process and tell GitHub what status to set (success, neutral or failure). Internally, these methods call process.exit with the appropriate exit code. You can pass an optional message to each one to be logged before exiting. This can be used like an early return:

if (someCheck) tools.exit.neutral('No _action_ necessary!') 
if (anError) tools.exit.failure('We failed!')
tools.exit.success('We did it team!')

What’s Changed

• Publish tags from releases (#40) @JasonEtco
• Allow only a list of events (#37) @JasonEtco
• Add methods to exit an action (#39) @JasonEtco

What’s Changed

• Defaults for store file path (#32) @JasonEtco
• Publish tags from releases (#40) @JasonEtco
• Allow only a list of events (#37) @JasonEtco

What’s Changed

• Defaults for store file path (#32) @JasonEtco
• More Dockerfile comments (#32) @JasonEtco

New features

tools.store

Your actions can store information in a file that is passed to the next actions in a workflow. It's a modified instance of flat-cache - note that the API is a little different:

tools.store.get('foo')
tools.store.set('foo', 'bar')

What’s Changed

• Add LABELs to the Dockerfile (#26) @JasonEtco
• Release workflow (#29) @JasonEtco
• Add add-an-issue-reference-action to usage list (#31) @kentaro-m
• Add a key/value store in a file (#30) @JasonEtco

What’s Changed

• Added LABELs and comments to the Dockerfile (#26) @JasonEtco

New feature

Bootstrap a new action by running the following:

npx actions-toolkit <name>

This will give you a Dockerfile and a .js file with actions-toolkit ready to go.

What’s Changed

• Release 1.0.0 (#21) @JasonEtco
• Remove @octokit/webhooks (#22) @JasonEtco
• Add note about GraphQL requests (#23) @JasonEtco
• CLI to bootstrap new Actions (#24) @JasonEtco
• Release 1.1.0 (#25) @JasonEtco

This release mostly centers around the Octokit client. It updates to a new major version of @octokit/rest, which puts this library more in line with their docs.

New features

tools.github.graphql

A pre-authenticated instance of @octokit/graphql, for all your GraphQL needs!

Breaking changes

tools.createOctokit() => tools.github

In practice, creating a new Octokit client isn't necessary 99% of the time, so this release changes it to be a single pre-authenticated instance.

// Before
const octokit = tools.createOctokit()
octokit.issues.create()

// After
tools.github.issues.create()

What’s Changed

• Fix type exports (#6) @JasonEtco
• Adding Actions to Usage list (#7) @lannonbr
• Update devDependencies (#9) @JasonEtco
• Updating Action name (#10) @lannonbr
• Add documentation for tools#getFile (#13) @JasonEtco
• Updating tools.arguments docs to show usage with .workflow file (#16) @lannonbr
• Update Octokit (#19) @JasonEtco
• Add a table of contents (#20) @JasonEtco
• Release 1.0.0 (#21) @JasonEtco

What’s Changed

• Fix type exports (#6) @JasonEtco

Better documentation

All of the docs were moved out of the docs folder, and into the README. This allows for better discoverability, and while its a little more work to maintain, it's a lot easier to control.

What’s Changed

• Add "using" section (#1) @JasonEtco
• Install Release-Drafter (#3) @JasonEtco
• Support for arguments (#4) @JasonEtco

Arguments

You can now access the arguments passed to your action via toolkit.arguments! This uses minimist to parse the arguments into a nicely consumable object.