Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝💅 Always render changelog draft @ Sphinx docs #12493

Merged

Conversation

webknjaz
Copy link
Member

@webknjaz webknjaz commented Jun 19, 2024

The earlier implementation was generating a temporary file, when the docs site was being built with tox. However, this was not enabled in RTD and is hackish.
This patch integrates the sphinxcontrib-towncrier extension to make it work in any environment where Sphinx docs are being built.

📝 Preview/demo: https://pytest--12493.org.readthedocs.build/en/12493/changelog.html#to-be-included-in-vrelease-if-present

@webknjaz
Copy link
Member Author

@RonnyPfannschmidt let's label this as a backport and skip news?

@webknjaz webknjaz force-pushed the maintenance/sphinx-towncrier-draft branch from 0aee63d to 467c47a Compare June 19, 2024 20:52
@webknjaz

This comment was marked as resolved.

@webknjaz webknjaz force-pushed the maintenance/sphinx-towncrier-draft branch 2 times, most recently from 971c17a to c2f5c8f Compare June 19, 2024 21:10
@RonnyPfannschmidt RonnyPfannschmidt added skip news used on prs to opt out of the changelog requirement backport 8.2.x labels Jun 20, 2024
The earlier implementation was generating a temporary file, when
the docs site was being built with `tox`. However, this was not
enabled in RTD and is hackish.
This patch integrates the `sphinxcontrib-towncrier` extension to
make it work in any environment where Sphinx docs are being built.
auto-merge was automatically disabled June 20, 2024 08:44

Head branch was pushed to by a user without write access

@webknjaz webknjaz force-pushed the maintenance/sphinx-towncrier-draft branch from c2f5c8f to e702079 Compare June 20, 2024 08:44
@RonnyPfannschmidt RonnyPfannschmidt merged commit 20dd1d6 into pytest-dev:main Jun 20, 2024
29 checks passed
Copy link

patchback bot commented Jun 20, 2024

Backport to 8.2.x: 💚 backport PR created

✅ Backport PR branch: patchback/backports/8.2.x/20dd1d6738d0623fe3176e796805bbd6e36cf831/pr-12493

Backported as #12495

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jun 20, 2024
…draft

📝💅 Always render changelog draft @ Sphinx docs

(cherry picked from commit 20dd1d6)
RonnyPfannschmidt added a commit that referenced this pull request Jun 20, 2024
…0dd1d6738d0623fe3176e796805bbd6e36cf831/pr-12493

[PR #12493/20dd1d67 backport][8.2.x] 📝💅 Always render changelog draft @ Sphinx docs
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 20, 2024
It is called when building the docs. Apparently, `tox -e docs` is not
invoked in CI, neither is it called in RTD, resulting in the
regression having been caught only in local development environments.

This is a follow-up for pytest-dev#12493.
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 20, 2024
It is uncapped in RTD. Apparently, `tox -e docs` is not invoked in CI,
neither is it called in RTD, resulting in the regression having been
caught only in local development environments.

This is a follow-up for pytest-dev#12493.
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 20, 2024
It is called when building the docs. Apparently, `tox -e docs` is not
invoked in CI, neither is it called in RTD, resulting in the
regression having been caught only in local development environments.

This is a follow-up for pytest-dev#12493.
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 20, 2024
It is uncapped in RTD. Apparently, `tox -e docs` is not invoked in CI,
neither is it called in RTD, resulting in the regression having been
caught only in local development environments.

This is a follow-up for pytest-dev#12493.
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 21, 2024
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 21, 2024
RonnyPfannschmidt added a commit that referenced this pull request Jun 21, 2024
…inx-towncrier-draft

📝 Add a change note for PR #12493
patchback bot pushed a commit that referenced this pull request Jun 21, 2024
…inx-towncrier-draft

📝 Add a change note for PR #12493

(cherry picked from commit dab29d3)
@webknjaz webknjaz added the type: infrastructure improvement to development/releases/CI structure label Jun 26, 2024
Glyphack pushed a commit to Glyphack/pytest that referenced this pull request Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip news used on prs to opt out of the changelog requirement type: infrastructure improvement to development/releases/CI structure
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants