Skip to content

Commit

Permalink
Monitoring.yml: Make rss field mandatory and include new template (#583)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Staudey
Staudey authored Nov 22, 2024
1 parent e355d1c commit c724e01
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/packaging/monitoring.yml.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,16 @@ go-task add-monitoring
Which will create a file with the following contents:

```yaml
# Remove all comments before submitting, except CPE check date if none found
releases:
id: null # Check https://release-monitoring.org/
rss: null # For example https://github.com/PyO3/maturin/releases.atom
id: ~ # Check https://release-monitoring.org/
rss: ~ # For example https://github.com/PyO3/maturin/releases.atom
# No known CPE, checked 2024-04-24
security:
cpe: ~
```
You must, at minimum, fill out `id` and check if the package has a [CPE name](#what-is-a-cpe-name). `rss` should be deleted if no feed is available.
You must, at minimum, fill out `id` and check if the package has an RSS feed and [CPE name](#what-is-a-cpe-name). If you can find no data for either of these fields, it must be set to `~`.

## systemd as an example

Expand Down Expand Up @@ -76,11 +77,11 @@ security:

Fields used to monitor for new versions.

| Field | Type | Required ? | Description |
| -------- | --------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | Anitya ID from [release-monitoring.org](https://release-monitoring.org/) |
| `ignore` | list of regular expressions | No | List of regular expressions enclosed in quotes matching versions to ignore. Include a comment explaining the ignored versions. |
| `rss` | URL | No, strongly encouraged | URL for a releases RSS feed. If the only RSS feed you can find for a project is a general "news" feed, don't include the field. For GitHub projects, you can use the "tags" or "releases" feed: `https://github.com/USER/REPOSITORY/tagsORreleases.atom` |
| Field | Type | Required ? | Description |
| -------- | --------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | Anitya ID from [release-monitoring.org](https://release-monitoring.org/) |
| `ignore` | list of regular expressions | No | List of regular expressions enclosed in quotes matching versions to ignore. Include a comment explaining the ignored versions. |
| `rss` | URL | Yes | URL for a releases RSS feed. If the only RSS feed you can find for a project is a general "news" feed, set it to `~`. For GitHub projects, you can use the "tags" or "releases" feed: `https://github.com/USER/REPOSITORY/tagsORreleases.atom` |

### Finding the Anitya ID

Expand Down

0 comments on commit c724e01

Please sign in to comment.