Creating secret.yml for github-well-architected#47
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
✅ Site Deployment Request SubmittedA request for live site deployment has been submitted. Next Steps
Note: If this contribution involves collaboration with GitHub, please contact your GitHub representative to help expedite the deployment process. Internal xref: |
There was a problem hiding this comment.
Pull request overview
Adds a MODA secrets.yml for the github-well-architected staging environment, defining Vault-backed secret metadata for deployment/runtime configuration.
Changes:
- Introduces
config/moda/secrets/staging/secrets.ymlwith initial secret entries for Copilot-related URLs and an HMAC key. - Sets
kind: latest_at_deployment_starton all entries.
Comments suppressed due to low confidence (2)
config/moda/secrets/staging/secrets.yml:23
CSE_COPILOT_SERVICE_URLalso has emptytype,owner, andexternally_usablefields. Please populate these with valid values (or, if it’s purely configuration, settype: configand remove/omit the extra keys) to avoid invalid/ambiguous secret classification.
CSE_COPILOT_SERVICE_URL:
key: CSE_COPILOT_SERVICE_URL
type:
owner:
playbook: ''
externally_usable:
kind: latest_at_deployment_start
config/moda/secrets/staging/secrets.yml:30
- The
kittensentry looks like placeholder/non-production data and is missing/invalid metadata (type: kittens, emptyowner, and emptyplaybook). If this is not a real secret, it should be removed; if it is real, please update it to use a validtype, add the owning team, and provide a playbook (or omit playbook iftype: config).
kittens:
key: kittens
type: kittens
owner: ''
playbook:
externally_usable: false
kind: latest_at_deployment_start
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| COPILOT_API_URL: | ||
| key: COPILOT_API_URL | ||
| type: | ||
| owner: | ||
| playbook: '' | ||
| externally_usable: | ||
| kind: latest_at_deployment_start |
There was a problem hiding this comment.
COPILOT_API_URL has empty required metadata fields (type, owner, and externally_usable). Please either set type to an appropriate value (e.g., config if it’s just configuration) and then omit the non-applicable keys, or fill in all required fields with valid values so this entry passes schema/lint validation.
This issue also appears in the following locations of the same file:
- line 17
- line 24
| key: kittens | ||
| type: kittens | ||
| owner: '' | ||
| playbook: |
There was a problem hiding this comment.
Empty fields are represented inconsistently (playbook: '' in some entries vs playbook: in kittens). Please use a consistent representation (prefer omitting optional keys or setting them to an explicit value) so downstream tooling doesn’t interpret empty string vs null differently.
| playbook: | |
| playbook: '' |
This pull request was automatically generated from
vault-chatops.It contains the secrets.yml file for
github-well-architectedinstaging.More info about this file can be found here
Please review these files and add missing information if possible.
These are the most important keys in the secrets.yml file:
key
This specifies the key in vault if it's not the same as the key for this secret
type
The type of secret. This is used to determine how the secret is used in the application.
Some secrets are just configuration. In that case the type is
configand the keysowner,playbookandexternally_usablecan be left out.For values like usernames that are used to authenticate, but are not a secret, the type
credentialsshould be used.A list of available types can be found here
owner
Which team owns the usage of the secret, not the central management service. If you are part of the sae-ps team, and the secret is a database credential your team uses, then you put in
@github/sae-psplaybook
Is there a playbook for rotating this secret? If so, please provide a link to it.
externally_usable
If this secret is leaked can it be used without GitHub network access? (like a GitHub PAT)
kind
This should probably be set to
latest_at_deployment_start.