Identity service updater

To add or remove the cinch-labs identity service's awareness of subdomains

🚒 Important: The way that custom TypeScript actions work is that they rely on you committing vanilla JS files to your main branch to then be referenced by consumers of the action. Do not be alarmed by the fact that the dist folder is commit to version control and please do not gitignore it!

Usage

Adding a subdomain infix

- name: Adding an infix
  uses: cinch-labs/update-identity-service@main
  with:
    auth-authority: ${{ secrets.AUTH_AUTHORITY }}
    access-key: ${{ secrets.ACCESS_KEY }}
    subdomain-infix: my-subdomain
    update-type: add # "add" is the default so specifying this is optional

Removing a subdomain infix

- name: Adding an infix
  uses: cinch-labs/update-identity-service@main
  with:
    auth-authority: ${{ secrets.AUTH_AUTHORITY }}
    access-key: ${{ secrets.ACCESS_KEY }}
    subdomain-infix: my-subdomain
    update-type: remove

Development

Install the dependencies

$ yarn

Build the typescript and package it for distribution

$ yarn build && yarn package

Testing

1. Start work on a new branch. If you want to test your changes in a live scenario you can reference your branch's version of the action in the consuming workflow as follows:

uses: cinch-labs/update-identity-service@your-branch-name

2. When you have finished your work, compile the action for release* and push those changes:

  yarn build
  yarn package

_{* These two commands are also run automatically as a git pre-commit hook}

3. Open a PR and, when the checks pass, merge it into main.

4. Congratulations your changes are now live on a branch!

Deployment

Merging your PR into the main branch will:

1. Trigger the same quality checks and integration tests that happen on a PR
2. If these pass it will run a build and commit the built files to the main branch
3. At this point your changes are live because any consumers of this action reference it by the @main label