Skip to content

Commit 5e04cee

Browse files
authored
Add check-release-notes CI job (#5)
Also add a release notes file and a template release notes file.
2 parents 4ddea4b + 0ff3bac commit 5e04cee

File tree

5 files changed

+82
-1
lines changed

5 files changed

+82
-1
lines changed

.github/RELEASE_NOTES.template.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Frequenz Component Graph Release Notes
2+
3+
## Summary
4+
5+
<!-- Here goes a general summary of what this release is about -->
6+
7+
## Upgrading
8+
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
11+
## New Features
12+
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
15+
## Bug Fixes
16+
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

.github/workflows/ci.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
name: Component Graph CI
22

33
on:
4+
merge_group:
45
push:
5-
branches: [ v0.x.x ]
6+
branches-ignore:
7+
# Ignore pushes to merge queues.
8+
# We only want to test the merge commit (`merge_group` event), the hashes
9+
# in the push were already tested by the PR checks
10+
- 'gh-readonly-queue/**'
11+
- 'dependabot/**'
612
pull_request:
713

814
jobs:
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Based on https://github.com/hyperledger/besu/pull/5207/files
2+
name: DCO
3+
on:
4+
merge_group:
5+
6+
jobs:
7+
DCO:
8+
runs-on: ubuntu-latest
9+
if: ${{ github.actor != 'dependabot[bot]' }}
10+
steps:
11+
- run: echo "This DCO job runs on merge_queue event and doesn't check PR contents"
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Release Notes Check
2+
3+
on:
4+
merge_group:
5+
pull_request:
6+
types:
7+
# On by default if you specify no types.
8+
- "opened"
9+
- "reopened"
10+
- "synchronize"
11+
# For `skip-label` only.
12+
- "labeled"
13+
- "unlabeled"
14+
15+
16+
jobs:
17+
check-release-notes:
18+
name: Check release notes are updated
19+
runs-on: ubuntu-latest
20+
permissions:
21+
pull-requests: read
22+
steps:
23+
- name: Check for a release notes update
24+
if: github.event_name == 'pull_request'
25+
uses: brettcannon/check-for-changed-files@871d7b8b5917a4f6f06662e2262e8ffc51dff6d1 # v1.2.1
26+
with:
27+
file-pattern: "RELEASE_NOTES.md"
28+
prereq-pattern: "src/**"
29+
skip-label: "cmd:skip-release-notes"
30+
failure-message: "Missing a release notes update. Please add one or apply the ${skip-label} label to the pull request"

RELEASE_NOTES.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Frequenz Component Graph Release Notes
2+
3+
## Summary
4+
5+
<!-- Here goes a general summary of what this release is about -->
6+
7+
## Upgrading
8+
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
11+
## New Features
12+
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
15+
## Bug Fixes
16+
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)