Skip to content

Commit 8996308

Browse files
committed
Update release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent b493c33 commit 8996308

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

RELEASE_NOTES.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,36 @@ To upgrade without regenerating the project, you can follow these steps:
2424

2525
Go to the repository settings -> **Rules** -> **Rulesets** -> **Protect version branches** -> **Bypass list** -> **Add bypass** -> Select **Maintain** role and change the dropdown bypass rule to use **Pull requests** instead of **Always**.
2626

27+
- The `labeler` action was upgraded to 5.0.0. This needs a new configuration file.
28+
29+
If you haven't diverged much from the default configuration (and you are not using exclusion rules), you can update the configuration file by running this script in the root of your repository:
30+
31+
```python
32+
import sys
33+
lines = []
34+
state = "looking"
35+
with open(".github/labeler.yml", encoding="utf-8") as fin:
36+
for line in fin:
37+
if "changed-files:" in line:
38+
sys.stderr.write("Already fixed, aborting...\n")
39+
sys.exit(1)
40+
match state:
41+
case "looking":
42+
if not line.startswith(("#", " ", "\t")) and line.rstrip().endswith(":"):
43+
line = f"{line} - changed-files:\n - any-glob-to-any-file:\n"
44+
state = "in-label"
45+
case "in-label":
46+
if not line.lstrip().startswith("-"):
47+
state = "looking"
48+
else:
49+
line = f" {line}"
50+
lines.append(line)
51+
with open(".github/labeler.yml", "w", encoding="utf-8") as fout:
52+
fout.writelines(lines)
53+
```
54+
55+
This will update the file in place, you can inspect the changes with `git diff`.
56+
2757
## New Features
2858
2959
<!-- Here goes the main new features and examples or instructions on how to use them -->
@@ -32,6 +62,7 @@ To upgrade without regenerating the project, you can follow these steps:
3262
3363
- Some checks that are already performed by `flake8` are now disabled in `pylint` to avoid double reporting.
3464
- The repository ruleset `Protect version branches` has been updated to allow repository maintainers to skip protection rules in PRs.
65+
- The `labeler` action was upgraded to 5.0.0, which allows for more complex matching rules.
3566
3667
## Bug Fixes
3768

0 commit comments

Comments
 (0)