Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.57 KB

admin-instructions.md

File metadata and controls

31 lines (22 loc) · 1.57 KB

Admin instructions

Allow the registry update script to push to a protected branch

The registry-update workflow runs the update.py script and pushes the changes to the current-registry branch.

The current-registry branch is locked (and should remain locked) so in order to allow the workflow to push changes to this branch we need to provide the workflow with a personal access token (PAT) of an admin or maintainer user.

The following steps must be taken by a user with "Admin" or "Maintainer" level permissions for this repository.

  1. create a PAT on GitHub with permission to write to this repository.
    • On github.com go to user settings: Settings > Developer Settings > Personal access tokens
    • Follow the steps to create a PAT (remember the value of the token for the next step)
  2. add that PAT to workflows for this repo
    • Now go to the settings for this repo: Settings > Secrets and variables > Actions
    • Create a new repository secret name DACCS_NODE_REGISTRY_PAT with the value of the token from step 1

Remember that if you set an expiry date for this token you'll need to repeat these steps when the token expires.

Manual steps when adding a new node

Before adding a new node to the registry for the first time, ensure that the node has the date_added field included in the registry. This should be an iso formatted datetime string which can be generated with the following snippet:

import datetime
datetime.datetime.now(tz=datetime.timezone.utc).isoformat()