MAGREQ-9001::Add metadata file to active repos #4232
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Overview
All Commerce engineering teams are being asked to add a new metadata file to all their active repositories. Kodiak team has committed to using this metadata file to make connections between repos, products, and teams. This small update will make following up on breaches, vulnerabilities, or ticket-able Kodiak findings much easier.
Creating the metadata file
In the default branch of your repo, create folder .github and add to it a file named .metadata.json.
Use the sample content below as a template to provide the necessary information.
{
"templateVersion": "0.2",
"product": {
"name": "Page Builder",
"description": "Content creation module for Magento",
},
"contacts": {
"team": {
"name": "Obesessive Owls",
"DL": "Grp-obsessive-owls-team", # this should not contain email, only DL names
"slackChannel": "#slack-channel"
}
},
"ticketTracker": {
"functionalJiraQueue": {
"projectKey": "PKGS",
"component": "
},
"securityJiraQueue": {
"projectKey": "MAGREQ",
"component": "MAGREQ/PageBuilder"
}
},
"productionCodeBranches": ["main"]
}
Create a PR to the default branch of your repo, making sure to link back to this ticket.
More detailed instructions can be found here: Onboarding for Teams
Which repos to update?
A metadata file should be created and added to all active repos belonging to your team. This includes public and private repos.
Related Issue
Closes https://jira.corp.adobe.com/browse/MAGREQ-9001
Acceptance
Verification Stakeholders
Specification
Verification Steps
Test scenario(s) for direct fix/feature
Test scenario(s) for any existing impacted features/areas
Test scenario(s) for any Magento Backend Supported Configurations
Is Browser/Device testing needed?
Any ad-hoc/edge case scenarios that need to be considered?
Screenshots / Screen Captures (if appropriate)
Breaking Changes (if any)
Checklist