microsoft / microsoft/AzureTRE
Convert non-secrets to GitHub environment variables to improve troubleshooting
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 235
- Forks
- 192
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 13
Description
A number of the values passed to the GitHub workflows as secrets are not actually secrets and should be converted to variables. e.g. TRE_ID is not a secret value and could be a variable.
Converting these to variables would make it easier to verify that all values are present and correct if the deployment fails - this is mostly necessary when deploying a new TRE (especially when using manual auth as it's easy to forget to add a client ID or put the wrong one in).
The only ones that look like they actually should be secrets are:
API_CLIENT_SECRET
APPLICATION_ADMIN_CLIENT_SECRET
TEST_WORKSPACE_APP_SECRET
TEST_ACCOUNT_CLIENT_SECRET
AZURE_CREDENTIALS
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the GitHub workflow definitions and the deployment configuration that reference the listed values, then compare each current secret with the exceptions identified in the issue. Done means non-secret values such as TRE_ID are exposed as environment variables for troubleshooting, while the five named credentials remain secrets and deployments still receive all required values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, github-actions
- Domain
- ci-cd, cloud
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 43/100