Skip to content

Commit

Permalink
chore: update contribution guide for actions templates (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
johneke-auth0 authored Jan 29, 2024
1 parent e3b56d9 commit b9106d1
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

For best practices, please review [our documentaton](https://auth0.com/docs/customize/actions/actions-templates#best-practices) and accompanying coding guidelines

#### Creating an Actions Template

To create a new actions template, follow the steps below:

1. Make sure you have all npm modules installed: `npm i` (from the root of this repo)
Expand All @@ -12,3 +14,27 @@ To create a new actions template, follow the steps below:
4. Open the newly generated `code.js` file and make sure to add your code implementation within the relevant generated exported functions
5. Make sure to test your `code.js` in a live tenant of your own to make sure it works as expected.
6. Once ready, create a pull request with your new actions template.

#### Updating an Actions Template

1. Locate the directory of the actions template you'd like to update under `templates/*`.
2. Update any details in the `manifest.yaml` or `code.js` contained within.
3. Create a pull request with your changes.

> [!NOTE]
>
> - You are not allowed to update the `id` of an actions template
#### Deleting an Actions Template

1. Locate the directory of the actions template you'd like to update under `templates/*`.
2. Look within `manifest.yaml` and set the `deleted` field to `true`.
3. Create a pull request with your changes.

#### Releasing Actions Templates

The actions team will periodically take the actions templates represented in this repo and deploy them.

> [!NOTE]
>
> There is no pre-determined cadence at which the actions templates in this repository are deployed.

0 comments on commit b9106d1

Please sign in to comment.