pybind / pybind11

Seamless operability between C++11 and Python
https://pybind11.readthedocs.io/
Other
15.39k stars 2.07k forks source link

Add command to check for vX.Y.Z tag vs pybind11/_version.py consistency. #4757

Closed rwgk closed 1 year ago

rwgk commented 1 year ago

Description

Slightly expand instructions based on lesson just learned (see #4756).

Piggy-backing hints for converting changelog to release message.

Suggested changelog entry:

rwgk commented 1 year ago

Hi @henryiii did you get a chance to look at this tiny update?

I just double-checked the git diff command, with a fresh eye, practicing a mock release. It does work as intended:

$ git diff "$(grep ^__version__ pybind11/_version.py | cut -d'"' -f2 | sed 's/^/v/')"
fatal: ambiguous argument 'v2.11.9': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'

I think that's exactly what we need as a last line of defense, right before the git push --tags in the instructions.

rwgk commented 1 year ago

@henryiii I removed a few line breaks to make it look better in the web view.

https://github.com/pybind/pybind11/blob/2b54c6539951cbd819b00b2140182bcf9a100ed7/docs/release.rst

Do you know if we can have the line breaks in the .rst file without making it look weird in the web view?

It's still not perfect, but good enough?

rwgk commented 1 year ago

It's still not perfect, but good enough?

With a lot of trial and error I finally figured out then main problem:

This is NOT GOOD:

- Bullet nesting level 1.
    - Bullet nesting level 2.

This is BETTER:

- Bullet nesting level 1.
  - Bullet nesting level 2.

With that and some minor miscellaneous polishing the rendered page on the web looks nice now. I'll go ahead and merge.