You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE_NOTES.md
+13-17Lines changed: 13 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,12 @@
2
2
3
3
## Summary
4
4
5
-
This release focuses on finishing the automation of dependabot updates, adding more automated upgrade workflows and fixing some problems with the previous release.
5
+
<!-- Here goes a general summary of what this release is about -->
6
6
7
7
## Upgrading
8
8
9
+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10
+
9
11
### Cookiecutter template
10
12
11
13
All upgrading should be done via the migration script or regenerating the templates.
@@ -14,28 +16,22 @@ All upgrading should be done via the migration script or regenerating the templa
<!-- Here upgrade steps for cookiecutter specifically -->
22
+
17
23
## New Features
18
24
25
+
<!-- Here goes the main new features and examples or instructions on how to use them -->
26
+
19
27
### Cookiecutter template
20
28
21
-
- The cookiecutter now asks whether a repository is private, defaults that answer from the selected license, and uses it to toggle private-repository workflow behavior, public publishing jobs, and the link to GitHub Discussions in the issue template chooser.
22
-
- All dependencies have been updated in the templates.
23
-
- API projects now ship a dedicated `grpc-migration.yaml` workflow that runs after Dependabot bumps `grpcio`/`grpcio-tools`/`protobuf` and rewrites the matching runtime `>=` floors in `pyproject.toml`.
24
-
- API projects now have a better grpcio/protobuf updates grouping in Dependabot, which should make upgrading easier, and plays nicer with the new `grpc-migration.yaml` workflow.
25
-
- API projects should now use the new API-specific *Protect version branches* ruleset variant, which includes the required `Fix gRPC/protobuf runtime floors` check without affecting non-API Python projects.
26
-
- Workflows using the `gh-action-dependabot-migrate` are upgraded to the latest version, which avoids unnecessary version iterations.
27
-
- Add an `isort-migration.yaml` workflow that automatically reorders imports when Dependabot upgrades `isort`.
29
+
<!-- Here new features for cookiecutter specifically -->
28
30
29
31
## Bug Fixes
30
32
33
+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
34
+
31
35
### Cookiecutter template
32
36
33
-
- The unused cross-arch QEMU-based testing infrastructure has been removed. The `.github/containers/nox-cross-arch/` and `.github/containers/test-installation/` directories, as well as the "Cross-Arch Testing" section in `CONTRIBUTING.md`.
34
-
- Private repositories now are generated with credentials uncommented and the publishing workflows disabled.
35
-
- The issue template chooser (`config.yml`) no longer includes the `contact_links` section for private repositories, since GitHub Discussions are typically disabled for them.
36
-
- Normalized the GitHub Action hashes for `gh-action-setup-git` and `gh-action-setup-python-with-deps` to point to the actual commit object, which is what Dependabot expects.
37
-
- API projects now configure black with `extend-exclude = '^/submodules/'` so the formatting check doesn't descend into external git submodules that don't follow our formatting rules.
38
-
- API projects now configure isort with `skip_glob = ["submodules/*"]` so the import-sorting check doesn't descend into external git submodules that don't follow our rules.
39
-
-`CONTRIBUTING.md`
40
-
* Fixed the nox example commands in to use the correct `tests/` directory instead of the non-existent `test/` directory.
41
-
* Fixed the wrong mention to PyPI publishing when releasing for private repositories.
37
+
<!-- Here bug fixes for cookiecutter specifically -->
0 commit comments