Skip to content

Commit 40798bc

Browse files
authored
ci: improve release notes format checking (#8984)
* chore: fix invalid release note * try improving relnote linting * add relnotes path * fix bad release note * improve reno config
1 parent 13c3768 commit 40798bc

File tree

5 files changed

+10
-5
lines changed

5 files changed

+10
-5
lines changed

.github/workflows/release_notes.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ on:
1313
- "**.py"
1414
- "pyproject.toml"
1515
- "!.github/**/*.py"
16+
- "releasenotes/notes/*.yaml"
1617

1718
jobs:
1819
reno:
@@ -45,4 +46,5 @@ jobs:
4546
- name: Verify release notes formatting
4647
if: steps.changed-files.outputs.any_changed == 'true' && !contains( github.event.pull_request.labels.*.name, 'ignore-for-release-notes')
4748
run: |
48-
yamllint -d "{extends: default, rules: {line-length: {max: 1200}}}" ${{ steps.changed-files.outputs.all_changed_files }}
49+
pip install "reno<5"
50+
reno lint . # it is not possible to pass a list of files to reno lint

.github/workflows/release_notes_skipper.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ on:
1313
- "**.py"
1414
- "pyproject.toml"
1515
- "!.github/**/*.py"
16+
- "releasenotes/notes/*.yaml"
1617

1718
jobs:
1819
reno:

releasenotes/config.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,14 @@ template: |
3737
Add normal bug fixes here, or remove this section.
3838
3939
sections:
40-
# The prelude section is implicitly included.
40+
# The highlights section is implicitly included.
4141
- [upgrade, Upgrade Notes]
4242
- [features, New Features]
4343
- [enhancements, Enhancement Notes]
4444
- [issues, Known Issues]
4545
- [deprecations, Deprecation Notes]
4646
- [security, Security Notes]
4747
- [fixes, Bug Fixes]
48+
# DO NOT REMOVE. The following sections are no longer used, but were used in the past. Keeping them here avoids reno linting errors.
49+
- [prelude, prelude]
50+
- [preview, preview]
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
enhancements:
33
- |
4-
Add batch_size to the __init__ method of FAISS Document Store. This works as the default value for all methods of
5-
FAISS Document Store that support batch_size.
4+
Add batch_size to the __init__ method of FAISS Document Store. This works as the default value for all methods of
5+
FAISS Document Store that support batch_size.

releasenotes/notes/run-async-azure-54450f0c2495f5c8.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
---
32
features:
43
- |
54
Add `run_async` method to `AzureOpenAIChatGenerator`. This method uses `AsyncAzureOpenAI`

0 commit comments

Comments
 (0)