Skip to content

Commit 60822ea

Browse files
committed
docs: add section about landing advisory update pull requests from the bot
1 parent ab07edd commit 60822ea

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
@@ -41,6 +41,23 @@ poetry run scripts/precache_nodes.py
4141
poetry run scripts/generate_osv_advisories.py
4242
```
4343

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

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

0 commit comments

Comments
 (0)