◐ Shell
reader mode source ↗
Skip to content

Doc: Fix archive filenames for standard builds#124826

Merged
AA-Turner merged 1 commit into
python:mainfrom
AA-Turner:docs/release-archives
Oct 1, 2024
Merged

Doc: Fix archive filenames for standard builds#124826
AA-Turner merged 1 commit into
python:mainfrom
AA-Turner:docs/release-archives

Conversation

@AA-Turner

@AA-Turner AA-Turner commented Oct 1, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

The recent commit 6318ffc (PR #124534) meant all created archive files (.zip and .tar.bz2) used the short {major}.{minor} version. This PR updates the logic so that only the daily rebuilds use the short version, with all other builds using the full release version.

Local test (daily rebuild):

$ make autobuild-dev-html
make dist-html SPHINXOPTS=' -A daily=1' DISTVERSION=3.14
make[1]: Entering directory '/mnt/s/Development/cpython/Doc'
# archive the HTML
Building HTML...
mkdir -p dist
rm -rf build/html
find dist -name 'python-3.14-docs-html*' -exec rm -rf {} \;
make html
make[2]: Entering directory '/mnt/s/Development/cpython/Doc'
[... snip ...]
Build finished. The HTML pages are in build/html.
make[2]: Leaving directory '/mnt/s/Development/cpython/Doc'
cp -pPR build/html dist/python-3.14-docs-html
tar -C dist -cf dist/python-3.14-docs-html.tar python-3.14-docs-html
bzip2 -9 -k dist/python-3.14-docs-html.tar
(cd dist; zip -q -r -9 python-3.14-docs-html.zip python-3.14-docs-html)
rm -r dist/python-3.14-docs-html
rm dist/python-3.14-docs-html.tar
Build finished and archived!
make[1]: Leaving directory '/mnt/s/Development/cpython/Doc'

Local test (standard build):

$ make dist-html
# archive the HTML
Building HTML...
mkdir -p dist
rm -rf build/html
find dist -name 'python-3.14.0a0-docs-html*' -exec rm -rf {} \;
make html
make[1]: Entering directory '/mnt/s/Development/cpython/Doc'
[... snip ...]
Build finished. The HTML pages are in build/html.
make[1]: Leaving directory '/mnt/s/Development/cpython/Doc'
cp -pPR build/html dist/python-3.14.0a0-docs-html
tar -C dist -cf dist/python-3.14.0a0-docs-html.tar python-3.14.0a0-docs-html
bzip2 -9 -k dist/python-3.14.0a0-docs-html.tar
(cd dist; zip -q -r -9 python-3.14.0a0-docs-html.zip python-3.14.0a0-docs-html)
rm -r dist/python-3.14.0a0-docs-html
rm dist/python-3.14.0a0-docs-html.tar
Build finished and archived!

A

📚 Documentation preview 📚: https://cpython-previews--124826.org.readthedocs.build/

@AA-Turner AA-Turner added docs Documentation in the Doc dir skip issue skip news needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Oct 1, 2024
@AA-Turner AA-Turner force-pushed the docs/release-archives branch from 3555af1 to dc66d41 Compare October 1, 2024 06:56
@ned-deily

ned-deily commented Oct 1, 2024

Copy link
Copy Markdown
Member

Does this problem affect the names of the doc download files produced by the RM for the currently in-process 3.13.0rc3 release? If so, should they be rebuilt?

cc: @Yhg1s

@hugovk

hugovk commented Oct 1, 2024

Copy link
Copy Markdown
Member

Thomas said on Discord he's manually fixed the in-process ones rather than restart the whole release process.

@AA-Turner AA-Turner merged commit 91e64be into python:main Oct 1, 2024
@AA-Turner AA-Turner deleted the docs/release-archives branch October 1, 2024 09:43
@miss-islington-app

miss-islington-app Bot commented Oct 1, 2024

Copy link
Copy Markdown

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 1, 2024
@AA-Turner @miss-islington
Doc: Fix archive filenames for standard builds (pythonGH-124826) …
cc37357 
(cherry picked from commit 91e64be)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 1, 2024
@AA-Turner @miss-islington
Doc: Fix archive filenames for standard builds (pythonGH-124826) …
a6d05d7 
(cherry picked from commit 91e64be)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Oct 1, 2024

Copy link
Copy Markdown

GH-124836 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Oct 1, 2024
@bedevere-app

bedevere-app Bot commented Oct 1, 2024

Copy link
Copy Markdown

GH-124837 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Oct 1, 2024
AA-Turner added a commit that referenced this pull request Oct 1, 2024
@miss-islington @AA-Turner
[3.12] Doc: Fix archive filenames for standard builds (GH-124826) (#1… …
9547d2a 
…24837)

Doc: Fix archive filenames for standard builds (GH-124826)
(cherry picked from commit 91e64be)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull request Oct 3, 2024
@miss-islington @AA-Turner
[3.13] Doc: Fix archive filenames for standard builds (GH-124826) (#1… …
4392c59 
…24836)

Doc: Fix archive filenames for standard builds (GH-124826)
(cherry picked from commit 91e64be)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

@Yhg1s Yhg1s Awaiting requested review from Yhg1s

@ned-deily ned-deily Awaiting requested review from ned-deily

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AA-Turner @ned-deily @hugovk