Skip to content

Commit 891ae69

Browse files
committed
docs: add section about landing advisory update pull requests from the bot
1 parent 38961b0 commit 891ae69

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,23 @@ poetry run scripts/precache_nodes.py
4343
poetry run scripts/generate_osv_advisories.py
4444
```
4545

46+
### Landing automated advisory updates
47+
48+
A
49+
[GitHub Actions workflow](https://github.com/ackama/drupal-advisory-database/blob/main/.github/workflows/generate.yml)
50+
runs regularly to regenerate the advisories, opening a pull request if there are
51+
changes.
52+
53+
Before being landed the changes should be reviewed for accuracy especially with
54+
the version constraints and ranges - these will usually be flagged by the
55+
generation script as warnings included in the `database_specific` sections of
56+
the advisories where relevant.
57+
58+
If an advisory does have a warning, you should aim to have it addressed using
59+
`patches.toml` described in the next section. This can be done by either pushing
60+
a new commit directly to the pull request branch, or through a new pull request
61+
after landing the changes to the advisories.
62+
4663
## Fixing incorrect data
4764

4865
Sometimes an advisory will have incorrect data, such as an affected version

0 commit comments

Comments
 (0)