Skip to content

Commit 4be88b8

Browse files
committed
feat: add CHANGELOG to make summarizing releases easier.
This adds a changelog in a keepachanglog.com style format. It's initially populated with currently unreleased behavior and the last release's (0.24.0) changes. Work towards bazel-contrib#1361
1 parent 504caab commit 4be88b8

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

CHANGELOG.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# rules_python Changelog
2+
3+
This is a human-friendly changelog in a keepachangelog.com style format.
4+
Because this changelog is for end-user consumption of meaningful changes,only
5+
a summary of a release's changes is described. This means every commit is not
6+
necessarily mentioned, and internal refactors or code cleanups are omitted
7+
unless they're particularly notable.
8+
9+
A brief description of the categories of changes:
10+
11+
* `Changed`: Some behavior changed. If the change is expected to break a
12+
public API or supported behavior, it will be marked as **BREAKING**. Note that
13+
beta APIs will not have breaking API changes called out.
14+
* `Fixed`: A bug, or otherwise incorrect behavior, was fixed.
15+
* `Added`: A new feature, API, or behavior was added in a backwards compatible
16+
manner.
17+
* Particular sub-systems are identified using parentheses, e.g. `(bzlmod)` or
18+
`(docs)`.
19+
20+
21+
## Unreleased
22+
23+
### Changed
24+
25+
* (bzlmod) `pip.parse` can no longer automatically use the default
26+
Python version; this was an unreliable and unsafe behavior. The
27+
`python_version` arg must always be explicitly specified.
28+
29+
### Fixed
30+
31+
* (docs) Update docs to use correct bzlmod APIs and clarify how and when to use
32+
various APIs.
33+
* (multi-version) The `main` arg is now correctly computed and usually optional.
34+
* (bzlmod) `pip.parse` no longer requires a call for whatever the configured
35+
default Python version is.
36+
37+
### Added
38+
39+
* (gazelle) Stop generating unnecessary imports
40+
* (toolchains) s390x supported for Python 3.9.17, 3.10.12, and 3.11.4.
41+
42+
## [0.24.0] - 2023-07-11
43+
44+
### Changed
45+
46+
* **BREAKING** (gazelle) Gazelle 0.30.0 or higher is required
47+
* (bzlmod) `@python_aliases` renamed to `@python_versions
48+
* (bzlmod) `pip.parse` arg `name` renamed to `hub_name`
49+
* (bzlmod) `pip.parse` arg `incompatible_generate_aliases` removed and always
50+
true.
51+
52+
### Fixed
53+
54+
* (bzlmod) Fixing Windows Python Interpreter symlink issues
55+
* (py_wheel) Allow twine tags and args
56+
* (toolchain, bzlmod) Restrict coverage tool visibility under bzlmod
57+
* (pip) Ignore temporary pyc.NNN files in wheels
58+
* (pip) Add format() calls to glob_exclude templates
59+
* plugin_output in py_proto_library rule
60+
61+
### Added
62+
63+
* Using Gazelle's lifecycle manager to manage external processes
64+
* (bzlmod) `pip.parse` can be called multiple times with different Python
65+
versions
66+
* (bzlmod) Allow bzlmod `pip.parse` to reference the default python toolchain and interpreter
67+
* (bzlmod) Implementing wheel annotations via `whl_mods`
68+
* (gazelle) support multiple requirements files in manifest generation
69+
* (py_wheel) Support for specifying `Description-Content-Type` and `Summary` in METADATA
70+
* (py_wheel) Support for specifying `Project-URL`
71+
* (compile_pip_requirements) Added `generate_hashes` arg (default True) to
72+
control generating hashes
73+
* (pip) Create all_data_requirements alias
74+
* Expose Python C headers through the toolchain.
75+
76+
[0.24.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.24.0
77+
78+

0 commit comments

Comments
 (0)