Skip to content

v2.0.0-beta.0

Pre-release
Pre-release
Compare
Choose a tag to compare
@JasonEtco JasonEtco released this 20 Mar 23:46

This release introduces a few breaking changes, for reliability and for clarity.

Required environment variables, #41

The first is a change to the Toolkit constructor - the list of environment variables that are available in the GitHub Actions runtime is now required when using actions-toolkit. This is to encourage predictability, and while it won't break any Actions being run by GitHub, it may affect automated tests that don't set all of the expected environment variables. I'm really looking for feedback on this change - if it feels too heavy handed, let me know in #62!

context.repo and context.issue are objects, not functions #61

I love this change (shoutout @jclem) - tools.context.repo and tools.context.issue are no longer functions that take an object parameter, but are rather helper getters that return an object:

- const params = tools.context.repo({ foo: true })
+ const params = { ...tools.context.repo, foo: true }

This is much more semantic and standard, and should result in less confusion for folks that aren't familiar with Probot's API.