diff --git a/.github/ISSUE_TEMPLATE/new-advisory.md b/.github/ISSUE_TEMPLATE/new-advisory.md index 967ab1b..90c0378 100644 --- a/.github/ISSUE_TEMPLATE/new-advisory.md +++ b/.github/ISSUE_TEMPLATE/new-advisory.md @@ -11,11 +11,7 @@ this database. -id: atomist-skills/A-2023-{{increment}} -cve ids: -cwe ids: -severity: -summary: -details: +id: atomist-skills/A-2023-{{increment}} cve ids: +cwe ids: severity: summary: details: diff --git a/README.md b/README.md index 5ecad6e..78653a0 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,9 @@ Advisories are managed in JSON files placed in directories of this repository. ### Adding Advisories Creating new advisories can be achieved by either creating a new JSON advisory -file in the `main` branch by manually or by opening a new GitHub issue -using the [_New advisory_](ADVISORY_TEMPLATE.json) issue template. Once the -issue is raised, a pull request with a new skeleton advisory JSON file is -opened. +file in the `main` branch by manually or by opening a new GitHub issue using the +[_New advisory_](ADVISORY_TEMPLATE.json) issue template. Once the issue is +raised, a pull request with a new skeleton advisory JSON file is opened. The content of advisory JSON files strictly follows the schema defined in [Open Source Vulnerability (OSV) format](https://ossf.github.io/osv-schema/). @@ -25,8 +24,8 @@ for examples of advisories. ### Updating Advisories To update an advisory, change the corresponding JSON advisory file either -directly in the `main` branch of this repository or raise a pull request -with your updates. +directly in the `main` branch of this repository or raise a pull request with +your updates. Once the changes are committed to the `main` branch, the advisory will get updated in the database automatically. A GitHub Check will indicate the @@ -35,8 +34,7 @@ successful update of the advisory. ### Deleting Advisories Deleting an advisory from the database can be achieved by removing the -corresponding JSON advisory file from the `main` branch of this -repository. +corresponding JSON advisory file from the `main` branch of this repository. > 💡 Only additions, changes and removals of JSON advisory files in the > repository's default branch are being processed and mirrored into the