GH-39737: [Release][Docs] Update post release documentation task - #39762

Merged
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script
Feb 6, 2024
Merged

GH-39737: [Release][Docs] Update post release documentation task#39762
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Jan 23, 2024

Copy link
Copy Markdown
Member

This PR updates the dev/release/post-08-docs.sh task so that

  • DOCUMENTATION_OPTIONS.theme_switcher_version_match changes from "" to "{previous_version}"
  • DOCUMENTATION_OPTIONS.show_version_warning_banner changes from false to true

for the documentation that is moved to a subfolder when a new major release is done.

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Jan 23, 2024
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 24, 2024
@AlenkaF
AlenkaF marked this pull request as ready for review January 30, 2024 07:20
@AlenkaF
AlenkaF requested a review from kouJanuary 30, 2024 07:20
kou
kou approved these changes Jan 31, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Just to confirm, did you try this change?

FYI: You can use dry-run by PUSH=0 dev/release/post-08-docs.sh VERSION PREVIOUS_VERSION.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF

Copy link
Copy Markdown
MemberAuthor

No didn't try, had no idea how to :) Will do as you suggest, thank you!

And if it looks good locally, I will go ahead and merge.

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

@kou, can the post release tasks be run (or dry-run) on MacOS?

@kou

kou commented Jan 31, 2024

Copy link
Copy Markdown
Member

Yes. It should work on macOS. Because a release manager may use macOS.

Did you get any error?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, sorry:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
dev/release/post-08-docs.sh: line 48: nproc: command not found
error: switch `j' requires a value

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Oh, could you try the following?

diff --git a/dev/release/post-08-docs.sh b/dev/release/post-08-docs.sh
index f18f7d10c7..a7529fdb2f 100755
--- a/dev/release/post-08-docs.sh+++ b/dev/release/post-08-docs.sh@@ -45,7 +45,16 @@ esac
pushd "${ARROW_SITE_DIR}"
source "${SOURCE_DIR}/git-vars.sh"
-git fetch --all --prune --tags --force -j$(nproc)+n_cpus=1+case $(uname) in+ Linux)+ n_cpus=$(nproc)+ ;;+ Darwin)+ n_cpus=$(sysctl -n hw.logicalcpu)+ ;;+esac+git fetch --all --prune --tags --force -j${n_cpus}
git checkout .
git checkout ${DEFAULT_BRANCH}
git clean -d -f -x

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

The suggested change fixes the issue 👍
Will add it as a commit to this PR if you agree.

I am dealing with next error currently:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': Updated 242 paths from the index
error: Your local changes to the following files would be overwritten by checkout:
docs/1.0/_sources/python/generated/pyarrow.Array.rst.txt
.
.
.
Aborting

Tried adding a fresh clone of arrow-site to see if that helps. Still waiting on this step (looks like it's stuck):

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

Hmm. Could you enable trace log by PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Sure. It still just hangs. Something with my connection to GitHub I guess?

(pyarrow-dev) alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0
+ set -e
+ set -u
+++ dirname dev/release/post-08-docs.sh
++ cd dev/release
++ pwd
+ SOURCE_DIR=/Users/alenkafrim/repos/arrow/dev/release
+ ARROW_DIR=/Users/alenkafrim/repos/arrow/dev/release/../..
+ : /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
+ '[' 2 -ne 2 ']'
+ version=15.0.0
+ previous_version=14.0.0
+ release_tag=apache-arrow-15.0.0
+ branch_name=release-docs-15.0.0
+ case "${version}" in
+ is_major_release=yes
+ pushd /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
~/repos/arrow-site ~/repos/arrow
+ source /Users/alenkafrim/repos/arrow/dev/release/git-vars.sh
+++ git rev-parse --abbrev-ref origin/HEAD
+++ sed s@origin/@@
++ DEFAULT_BRANCH=master
+ n_cpus=1
+ case $(uname) in
++ uname
++ sysctl -n hw.logicalcpu
+ n_cpus=8
+ git fetch --all --prune --tags --force -j8
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

Ah, you need to enter your passphrase for /Users/alenkafrim/.ssh/id_ed25519. Did you enter it?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, I did. First time it worked, now it gets stuck every time ...

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Ha, I tried hitting enter again (twice that is) and got:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
could not fetch 'origin' (exit code: 128)
From github.com:apache/arrow-site
1c75ee2aac8..fb0b8437439 asf-site -> apache/asf-site
87135b28d69..2dc7804b653 main -> apache/main

I just started using ssh key with github so need to check why it is not working. Sorry for the spam!

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

No problem. :-)
You may want to use ssh-agent or something to avoid entering passphrase multiple times.

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested locally and there is one change required (previous_series instead of previous_version) and a couple minor changes in order to split the commits in two so it's easier if we require to review them.

Comment threaddev/release/post-08-docs.sh
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally with PUSH=0 and it works as expected!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF
AlenkaF requested a review from kouFebruary 5, 2024 12:06
kou
kou approved these changes Feb 6, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 874e596 into apache:mainFeb 6, 2024
@koukou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Feb 6, 2024
@AlenkaF
AlenkaF deleted the gh-39737-update-docs-release-script branch February 6, 2024 08:07
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 874e596.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
apache#39762)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: apache#39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
raulcd added a commit that referenced this pull request Feb 20, 2024
)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: #39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting mergeAwaiting merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website][Docs] index page shows wrong warning bar at top when 15.0 is selected

3 participants

@AlenkaF@kou@raulcd
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

GH-39737: [Release][Docs] Update post release documentation task - #39762

Merged
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script
Feb 6, 2024
Merged

GH-39737: [Release][Docs] Update post release documentation task#39762
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Jan 23, 2024

Copy link
Copy Markdown
Member

This PR updates the dev/release/post-08-docs.sh task so that

  • DOCUMENTATION_OPTIONS.theme_switcher_version_match changes from "" to "{previous_version}"
  • DOCUMENTATION_OPTIONS.show_version_warning_banner changes from false to true

for the documentation that is moved to a subfolder when a new major release is done.

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Jan 23, 2024
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 24, 2024
@AlenkaF
AlenkaF marked this pull request as ready for review January 30, 2024 07:20
@AlenkaF
AlenkaF requested a review from kouJanuary 30, 2024 07:20
kou
kou approved these changes Jan 31, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Just to confirm, did you try this change?

FYI: You can use dry-run by PUSH=0 dev/release/post-08-docs.sh VERSION PREVIOUS_VERSION.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF

Copy link
Copy Markdown
MemberAuthor

No didn't try, had no idea how to :) Will do as you suggest, thank you!

And if it looks good locally, I will go ahead and merge.

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

@kou, can the post release tasks be run (or dry-run) on MacOS?

@kou

kou commented Jan 31, 2024

Copy link
Copy Markdown
Member

Yes. It should work on macOS. Because a release manager may use macOS.

Did you get any error?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, sorry:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
dev/release/post-08-docs.sh: line 48: nproc: command not found
error: switch `j' requires a value

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Oh, could you try the following?

diff --git a/dev/release/post-08-docs.sh b/dev/release/post-08-docs.sh
index f18f7d10c7..a7529fdb2f 100755
--- a/dev/release/post-08-docs.sh+++ b/dev/release/post-08-docs.sh@@ -45,7 +45,16 @@ esac
pushd "${ARROW_SITE_DIR}"
source "${SOURCE_DIR}/git-vars.sh"
-git fetch --all --prune --tags --force -j$(nproc)+n_cpus=1+case $(uname) in+ Linux)+ n_cpus=$(nproc)+ ;;+ Darwin)+ n_cpus=$(sysctl -n hw.logicalcpu)+ ;;+esac+git fetch --all --prune --tags --force -j${n_cpus}
git checkout .
git checkout ${DEFAULT_BRANCH}
git clean -d -f -x

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

The suggested change fixes the issue 👍
Will add it as a commit to this PR if you agree.

I am dealing with next error currently:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': Updated 242 paths from the index
error: Your local changes to the following files would be overwritten by checkout:
docs/1.0/_sources/python/generated/pyarrow.Array.rst.txt
.
.
.
Aborting

Tried adding a fresh clone of arrow-site to see if that helps. Still waiting on this step (looks like it's stuck):

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

Hmm. Could you enable trace log by PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Sure. It still just hangs. Something with my connection to GitHub I guess?

(pyarrow-dev) alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0
+ set -e
+ set -u
+++ dirname dev/release/post-08-docs.sh
++ cd dev/release
++ pwd
+ SOURCE_DIR=/Users/alenkafrim/repos/arrow/dev/release
+ ARROW_DIR=/Users/alenkafrim/repos/arrow/dev/release/../..
+ : /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
+ '[' 2 -ne 2 ']'
+ version=15.0.0
+ previous_version=14.0.0
+ release_tag=apache-arrow-15.0.0
+ branch_name=release-docs-15.0.0
+ case "${version}" in
+ is_major_release=yes
+ pushd /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
~/repos/arrow-site ~/repos/arrow
+ source /Users/alenkafrim/repos/arrow/dev/release/git-vars.sh
+++ git rev-parse --abbrev-ref origin/HEAD
+++ sed s@origin/@@
++ DEFAULT_BRANCH=master
+ n_cpus=1
+ case $(uname) in
++ uname
++ sysctl -n hw.logicalcpu
+ n_cpus=8
+ git fetch --all --prune --tags --force -j8
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

Ah, you need to enter your passphrase for /Users/alenkafrim/.ssh/id_ed25519. Did you enter it?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, I did. First time it worked, now it gets stuck every time ...

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Ha, I tried hitting enter again (twice that is) and got:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
could not fetch 'origin' (exit code: 128)
From github.com:apache/arrow-site
1c75ee2aac8..fb0b8437439 asf-site -> apache/asf-site
87135b28d69..2dc7804b653 main -> apache/main

I just started using ssh key with github so need to check why it is not working. Sorry for the spam!

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

No problem. :-)
You may want to use ssh-agent or something to avoid entering passphrase multiple times.

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested locally and there is one change required (previous_series instead of previous_version) and a couple minor changes in order to split the commits in two so it's easier if we require to review them.

Comment threaddev/release/post-08-docs.sh
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally with PUSH=0 and it works as expected!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF
AlenkaF requested a review from kouFebruary 5, 2024 12:06
kou
kou approved these changes Feb 6, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 874e596 into apache:mainFeb 6, 2024
@koukou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Feb 6, 2024
@AlenkaF
AlenkaF deleted the gh-39737-update-docs-release-script branch February 6, 2024 08:07
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 874e596.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
apache#39762)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: apache#39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
raulcd added a commit that referenced this pull request Feb 20, 2024
)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: #39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting mergeAwaiting merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website][Docs] index page shows wrong warning bar at top when 15.0 is selected

3 participants

@AlenkaF@kou@raulcd
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-39737: [Release][Docs] Update post release documentation task - #39762

Merged
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script
Feb 6, 2024
Merged

GH-39737: [Release][Docs] Update post release documentation task#39762
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Jan 23, 2024

Copy link
Copy Markdown
Member

This PR updates the dev/release/post-08-docs.sh task so that

  • DOCUMENTATION_OPTIONS.theme_switcher_version_match changes from "" to "{previous_version}"
  • DOCUMENTATION_OPTIONS.show_version_warning_banner changes from false to true

for the documentation that is moved to a subfolder when a new major release is done.

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Jan 23, 2024
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 24, 2024
@AlenkaF
AlenkaF marked this pull request as ready for review January 30, 2024 07:20
@AlenkaF
AlenkaF requested a review from kouJanuary 30, 2024 07:20
kou
kou approved these changes Jan 31, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Just to confirm, did you try this change?

FYI: You can use dry-run by PUSH=0 dev/release/post-08-docs.sh VERSION PREVIOUS_VERSION.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF

Copy link
Copy Markdown
MemberAuthor

No didn't try, had no idea how to :) Will do as you suggest, thank you!

And if it looks good locally, I will go ahead and merge.

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

@kou, can the post release tasks be run (or dry-run) on MacOS?

@kou

kou commented Jan 31, 2024

Copy link
Copy Markdown
Member

Yes. It should work on macOS. Because a release manager may use macOS.

Did you get any error?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, sorry:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
dev/release/post-08-docs.sh: line 48: nproc: command not found
error: switch `j' requires a value

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Oh, could you try the following?

diff --git a/dev/release/post-08-docs.sh b/dev/release/post-08-docs.sh
index f18f7d10c7..a7529fdb2f 100755
--- a/dev/release/post-08-docs.sh+++ b/dev/release/post-08-docs.sh@@ -45,7 +45,16 @@ esac
pushd "${ARROW_SITE_DIR}"
source "${SOURCE_DIR}/git-vars.sh"
-git fetch --all --prune --tags --force -j$(nproc)+n_cpus=1+case $(uname) in+ Linux)+ n_cpus=$(nproc)+ ;;+ Darwin)+ n_cpus=$(sysctl -n hw.logicalcpu)+ ;;+esac+git fetch --all --prune --tags --force -j${n_cpus}
git checkout .
git checkout ${DEFAULT_BRANCH}
git clean -d -f -x

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

The suggested change fixes the issue 👍
Will add it as a commit to this PR if you agree.

I am dealing with next error currently:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': Updated 242 paths from the index
error: Your local changes to the following files would be overwritten by checkout:
docs/1.0/_sources/python/generated/pyarrow.Array.rst.txt
.
.
.
Aborting

Tried adding a fresh clone of arrow-site to see if that helps. Still waiting on this step (looks like it's stuck):

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

Hmm. Could you enable trace log by PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Sure. It still just hangs. Something with my connection to GitHub I guess?

(pyarrow-dev) alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0
+ set -e
+ set -u
+++ dirname dev/release/post-08-docs.sh
++ cd dev/release
++ pwd
+ SOURCE_DIR=/Users/alenkafrim/repos/arrow/dev/release
+ ARROW_DIR=/Users/alenkafrim/repos/arrow/dev/release/../..
+ : /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
+ '[' 2 -ne 2 ']'
+ version=15.0.0
+ previous_version=14.0.0
+ release_tag=apache-arrow-15.0.0
+ branch_name=release-docs-15.0.0
+ case "${version}" in
+ is_major_release=yes
+ pushd /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
~/repos/arrow-site ~/repos/arrow
+ source /Users/alenkafrim/repos/arrow/dev/release/git-vars.sh
+++ git rev-parse --abbrev-ref origin/HEAD
+++ sed s@origin/@@
++ DEFAULT_BRANCH=master
+ n_cpus=1
+ case $(uname) in
++ uname
++ sysctl -n hw.logicalcpu
+ n_cpus=8
+ git fetch --all --prune --tags --force -j8
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

Ah, you need to enter your passphrase for /Users/alenkafrim/.ssh/id_ed25519. Did you enter it?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, I did. First time it worked, now it gets stuck every time ...

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Ha, I tried hitting enter again (twice that is) and got:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
could not fetch 'origin' (exit code: 128)
From github.com:apache/arrow-site
1c75ee2aac8..fb0b8437439 asf-site -> apache/asf-site
87135b28d69..2dc7804b653 main -> apache/main

I just started using ssh key with github so need to check why it is not working. Sorry for the spam!

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

No problem. :-)
You may want to use ssh-agent or something to avoid entering passphrase multiple times.

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested locally and there is one change required (previous_series instead of previous_version) and a couple minor changes in order to split the commits in two so it's easier if we require to review them.

Comment threaddev/release/post-08-docs.sh
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally with PUSH=0 and it works as expected!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF
AlenkaF requested a review from kouFebruary 5, 2024 12:06
kou
kou approved these changes Feb 6, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 874e596 into apache:mainFeb 6, 2024
@koukou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Feb 6, 2024
@AlenkaF
AlenkaF deleted the gh-39737-update-docs-release-script branch February 6, 2024 08:07
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 874e596.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
apache#39762)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: apache#39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
raulcd added a commit that referenced this pull request Feb 20, 2024
)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: #39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting mergeAwaiting merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website][Docs] index page shows wrong warning bar at top when 15.0 is selected

3 participants

@AlenkaF@kou@raulcd
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-39737: [Release][Docs] Update post release documentation task - #39762

Merged
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script
Feb 6, 2024
Merged

GH-39737: [Release][Docs] Update post release documentation task#39762
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Jan 23, 2024

Copy link
Copy Markdown
Member

This PR updates the dev/release/post-08-docs.sh task so that

  • DOCUMENTATION_OPTIONS.theme_switcher_version_match changes from "" to "{previous_version}"
  • DOCUMENTATION_OPTIONS.show_version_warning_banner changes from false to true

for the documentation that is moved to a subfolder when a new major release is done.

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Jan 23, 2024
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 24, 2024
@AlenkaF
AlenkaF marked this pull request as ready for review January 30, 2024 07:20
@AlenkaF
AlenkaF requested a review from kouJanuary 30, 2024 07:20
kou
kou approved these changes Jan 31, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Just to confirm, did you try this change?

FYI: You can use dry-run by PUSH=0 dev/release/post-08-docs.sh VERSION PREVIOUS_VERSION.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF

Copy link
Copy Markdown
MemberAuthor

No didn't try, had no idea how to :) Will do as you suggest, thank you!

And if it looks good locally, I will go ahead and merge.

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

@kou, can the post release tasks be run (or dry-run) on MacOS?

@kou

kou commented Jan 31, 2024

Copy link
Copy Markdown
Member

Yes. It should work on macOS. Because a release manager may use macOS.

Did you get any error?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, sorry:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
dev/release/post-08-docs.sh: line 48: nproc: command not found
error: switch `j' requires a value

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Oh, could you try the following?

diff --git a/dev/release/post-08-docs.sh b/dev/release/post-08-docs.sh
index f18f7d10c7..a7529fdb2f 100755
--- a/dev/release/post-08-docs.sh+++ b/dev/release/post-08-docs.sh@@ -45,7 +45,16 @@ esac
pushd "${ARROW_SITE_DIR}"
source "${SOURCE_DIR}/git-vars.sh"
-git fetch --all --prune --tags --force -j$(nproc)+n_cpus=1+case $(uname) in+ Linux)+ n_cpus=$(nproc)+ ;;+ Darwin)+ n_cpus=$(sysctl -n hw.logicalcpu)+ ;;+esac+git fetch --all --prune --tags --force -j${n_cpus}
git checkout .
git checkout ${DEFAULT_BRANCH}
git clean -d -f -x

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

The suggested change fixes the issue 👍
Will add it as a commit to this PR if you agree.

I am dealing with next error currently:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': Updated 242 paths from the index
error: Your local changes to the following files would be overwritten by checkout:
docs/1.0/_sources/python/generated/pyarrow.Array.rst.txt
.
.
.
Aborting

Tried adding a fresh clone of arrow-site to see if that helps. Still waiting on this step (looks like it's stuck):

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

Hmm. Could you enable trace log by PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Sure. It still just hangs. Something with my connection to GitHub I guess?

(pyarrow-dev) alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0
+ set -e
+ set -u
+++ dirname dev/release/post-08-docs.sh
++ cd dev/release
++ pwd
+ SOURCE_DIR=/Users/alenkafrim/repos/arrow/dev/release
+ ARROW_DIR=/Users/alenkafrim/repos/arrow/dev/release/../..
+ : /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
+ '[' 2 -ne 2 ']'
+ version=15.0.0
+ previous_version=14.0.0
+ release_tag=apache-arrow-15.0.0
+ branch_name=release-docs-15.0.0
+ case "${version}" in
+ is_major_release=yes
+ pushd /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
~/repos/arrow-site ~/repos/arrow
+ source /Users/alenkafrim/repos/arrow/dev/release/git-vars.sh
+++ git rev-parse --abbrev-ref origin/HEAD
+++ sed s@origin/@@
++ DEFAULT_BRANCH=master
+ n_cpus=1
+ case $(uname) in
++ uname
++ sysctl -n hw.logicalcpu
+ n_cpus=8
+ git fetch --all --prune --tags --force -j8
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

Ah, you need to enter your passphrase for /Users/alenkafrim/.ssh/id_ed25519. Did you enter it?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, I did. First time it worked, now it gets stuck every time ...

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Ha, I tried hitting enter again (twice that is) and got:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
could not fetch 'origin' (exit code: 128)
From github.com:apache/arrow-site
1c75ee2aac8..fb0b8437439 asf-site -> apache/asf-site
87135b28d69..2dc7804b653 main -> apache/main

I just started using ssh key with github so need to check why it is not working. Sorry for the spam!

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

No problem. :-)
You may want to use ssh-agent or something to avoid entering passphrase multiple times.

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested locally and there is one change required (previous_series instead of previous_version) and a couple minor changes in order to split the commits in two so it's easier if we require to review them.

Comment threaddev/release/post-08-docs.sh
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally with PUSH=0 and it works as expected!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF
AlenkaF requested a review from kouFebruary 5, 2024 12:06
kou
kou approved these changes Feb 6, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 874e596 into apache:mainFeb 6, 2024
@koukou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Feb 6, 2024
@AlenkaF
AlenkaF deleted the gh-39737-update-docs-release-script branch February 6, 2024 08:07
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 874e596.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
apache#39762)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: apache#39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
raulcd added a commit that referenced this pull request Feb 20, 2024
)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: #39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting mergeAwaiting merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website][Docs] index page shows wrong warning bar at top when 15.0 is selected

3 participants

@AlenkaF@kou@raulcd
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

GH-39737: [Release][Docs] Update post release documentation task - #39762

Merged
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script
Feb 6, 2024
Merged

GH-39737: [Release][Docs] Update post release documentation task#39762
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Jan 23, 2024

Copy link
Copy Markdown
Member

This PR updates the dev/release/post-08-docs.sh task so that

  • DOCUMENTATION_OPTIONS.theme_switcher_version_match changes from "" to "{previous_version}"
  • DOCUMENTATION_OPTIONS.show_version_warning_banner changes from false to true

for the documentation that is moved to a subfolder when a new major release is done.

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Jan 23, 2024
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 24, 2024
@AlenkaF
AlenkaF marked this pull request as ready for review January 30, 2024 07:20
@AlenkaF
AlenkaF requested a review from kouJanuary 30, 2024 07:20
kou
kou approved these changes Jan 31, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Just to confirm, did you try this change?

FYI: You can use dry-run by PUSH=0 dev/release/post-08-docs.sh VERSION PREVIOUS_VERSION.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF

Copy link
Copy Markdown
MemberAuthor

No didn't try, had no idea how to :) Will do as you suggest, thank you!

And if it looks good locally, I will go ahead and merge.

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

@kou, can the post release tasks be run (or dry-run) on MacOS?

@kou

kou commented Jan 31, 2024

Copy link
Copy Markdown
Member

Yes. It should work on macOS. Because a release manager may use macOS.

Did you get any error?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, sorry:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
dev/release/post-08-docs.sh: line 48: nproc: command not found
error: switch `j' requires a value

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Oh, could you try the following?

diff --git a/dev/release/post-08-docs.sh b/dev/release/post-08-docs.sh
index f18f7d10c7..a7529fdb2f 100755
--- a/dev/release/post-08-docs.sh+++ b/dev/release/post-08-docs.sh@@ -45,7 +45,16 @@ esac
pushd "${ARROW_SITE_DIR}"
source "${SOURCE_DIR}/git-vars.sh"
-git fetch --all --prune --tags --force -j$(nproc)+n_cpus=1+case $(uname) in+ Linux)+ n_cpus=$(nproc)+ ;;+ Darwin)+ n_cpus=$(sysctl -n hw.logicalcpu)+ ;;+esac+git fetch --all --prune --tags --force -j${n_cpus}
git checkout .
git checkout ${DEFAULT_BRANCH}
git clean -d -f -x

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

The suggested change fixes the issue 👍
Will add it as a commit to this PR if you agree.

I am dealing with next error currently:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': Updated 242 paths from the index
error: Your local changes to the following files would be overwritten by checkout:
docs/1.0/_sources/python/generated/pyarrow.Array.rst.txt
.
.
.
Aborting

Tried adding a fresh clone of arrow-site to see if that helps. Still waiting on this step (looks like it's stuck):

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

Hmm. Could you enable trace log by PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Sure. It still just hangs. Something with my connection to GitHub I guess?

(pyarrow-dev) alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0
+ set -e
+ set -u
+++ dirname dev/release/post-08-docs.sh
++ cd dev/release
++ pwd
+ SOURCE_DIR=/Users/alenkafrim/repos/arrow/dev/release
+ ARROW_DIR=/Users/alenkafrim/repos/arrow/dev/release/../..
+ : /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
+ '[' 2 -ne 2 ']'
+ version=15.0.0
+ previous_version=14.0.0
+ release_tag=apache-arrow-15.0.0
+ branch_name=release-docs-15.0.0
+ case "${version}" in
+ is_major_release=yes
+ pushd /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
~/repos/arrow-site ~/repos/arrow
+ source /Users/alenkafrim/repos/arrow/dev/release/git-vars.sh
+++ git rev-parse --abbrev-ref origin/HEAD
+++ sed s@origin/@@
++ DEFAULT_BRANCH=master
+ n_cpus=1
+ case $(uname) in
++ uname
++ sysctl -n hw.logicalcpu
+ n_cpus=8
+ git fetch --all --prune --tags --force -j8
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

Ah, you need to enter your passphrase for /Users/alenkafrim/.ssh/id_ed25519. Did you enter it?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, I did. First time it worked, now it gets stuck every time ...

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Ha, I tried hitting enter again (twice that is) and got:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
could not fetch 'origin' (exit code: 128)
From github.com:apache/arrow-site
1c75ee2aac8..fb0b8437439 asf-site -> apache/asf-site
87135b28d69..2dc7804b653 main -> apache/main

I just started using ssh key with github so need to check why it is not working. Sorry for the spam!

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

No problem. :-)
You may want to use ssh-agent or something to avoid entering passphrase multiple times.

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested locally and there is one change required (previous_series instead of previous_version) and a couple minor changes in order to split the commits in two so it's easier if we require to review them.

Comment threaddev/release/post-08-docs.sh
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally with PUSH=0 and it works as expected!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF
AlenkaF requested a review from kouFebruary 5, 2024 12:06
kou
kou approved these changes Feb 6, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 874e596 into apache:mainFeb 6, 2024
@koukou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Feb 6, 2024
@AlenkaF
AlenkaF deleted the gh-39737-update-docs-release-script branch February 6, 2024 08:07
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 874e596.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
apache#39762)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: apache#39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
raulcd added a commit that referenced this pull request Feb 20, 2024
)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: #39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting mergeAwaiting merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website][Docs] index page shows wrong warning bar at top when 15.0 is selected

3 participants

@AlenkaF@kou@raulcd
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-39737: [Release][Docs] Update post release documentation task - #39762

Merged
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script
Feb 6, 2024
Merged

GH-39737: [Release][Docs] Update post release documentation task#39762
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Jan 23, 2024

Copy link
Copy Markdown
Member

This PR updates the dev/release/post-08-docs.sh task so that

  • DOCUMENTATION_OPTIONS.theme_switcher_version_match changes from "" to "{previous_version}"
  • DOCUMENTATION_OPTIONS.show_version_warning_banner changes from false to true

for the documentation that is moved to a subfolder when a new major release is done.

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Jan 23, 2024
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 24, 2024
@AlenkaF
AlenkaF marked this pull request as ready for review January 30, 2024 07:20
@AlenkaF
AlenkaF requested a review from kouJanuary 30, 2024 07:20
kou
kou approved these changes Jan 31, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Just to confirm, did you try this change?

FYI: You can use dry-run by PUSH=0 dev/release/post-08-docs.sh VERSION PREVIOUS_VERSION.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF

Copy link
Copy Markdown
MemberAuthor

No didn't try, had no idea how to :) Will do as you suggest, thank you!

And if it looks good locally, I will go ahead and merge.

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

@kou, can the post release tasks be run (or dry-run) on MacOS?

@kou

kou commented Jan 31, 2024

Copy link
Copy Markdown
Member

Yes. It should work on macOS. Because a release manager may use macOS.

Did you get any error?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, sorry:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
dev/release/post-08-docs.sh: line 48: nproc: command not found
error: switch `j' requires a value

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Oh, could you try the following?

diff --git a/dev/release/post-08-docs.sh b/dev/release/post-08-docs.sh
index f18f7d10c7..a7529fdb2f 100755
--- a/dev/release/post-08-docs.sh+++ b/dev/release/post-08-docs.sh@@ -45,7 +45,16 @@ esac
pushd "${ARROW_SITE_DIR}"
source "${SOURCE_DIR}/git-vars.sh"
-git fetch --all --prune --tags --force -j$(nproc)+n_cpus=1+case $(uname) in+ Linux)+ n_cpus=$(nproc)+ ;;+ Darwin)+ n_cpus=$(sysctl -n hw.logicalcpu)+ ;;+esac+git fetch --all --prune --tags --force -j${n_cpus}
git checkout .
git checkout ${DEFAULT_BRANCH}
git clean -d -f -x

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

The suggested change fixes the issue 👍
Will add it as a commit to this PR if you agree.

I am dealing with next error currently:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': Updated 242 paths from the index
error: Your local changes to the following files would be overwritten by checkout:
docs/1.0/_sources/python/generated/pyarrow.Array.rst.txt
.
.
.
Aborting

Tried adding a fresh clone of arrow-site to see if that helps. Still waiting on this step (looks like it's stuck):

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

Hmm. Could you enable trace log by PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Sure. It still just hangs. Something with my connection to GitHub I guess?

(pyarrow-dev) alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0
+ set -e
+ set -u
+++ dirname dev/release/post-08-docs.sh
++ cd dev/release
++ pwd
+ SOURCE_DIR=/Users/alenkafrim/repos/arrow/dev/release
+ ARROW_DIR=/Users/alenkafrim/repos/arrow/dev/release/../..
+ : /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
+ '[' 2 -ne 2 ']'
+ version=15.0.0
+ previous_version=14.0.0
+ release_tag=apache-arrow-15.0.0
+ branch_name=release-docs-15.0.0
+ case "${version}" in
+ is_major_release=yes
+ pushd /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
~/repos/arrow-site ~/repos/arrow
+ source /Users/alenkafrim/repos/arrow/dev/release/git-vars.sh
+++ git rev-parse --abbrev-ref origin/HEAD
+++ sed s@origin/@@
++ DEFAULT_BRANCH=master
+ n_cpus=1
+ case $(uname) in
++ uname
++ sysctl -n hw.logicalcpu
+ n_cpus=8
+ git fetch --all --prune --tags --force -j8
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

Ah, you need to enter your passphrase for /Users/alenkafrim/.ssh/id_ed25519. Did you enter it?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, I did. First time it worked, now it gets stuck every time ...

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Ha, I tried hitting enter again (twice that is) and got:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
could not fetch 'origin' (exit code: 128)
From github.com:apache/arrow-site
1c75ee2aac8..fb0b8437439 asf-site -> apache/asf-site
87135b28d69..2dc7804b653 main -> apache/main

I just started using ssh key with github so need to check why it is not working. Sorry for the spam!

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

No problem. :-)
You may want to use ssh-agent or something to avoid entering passphrase multiple times.

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested locally and there is one change required (previous_series instead of previous_version) and a couple minor changes in order to split the commits in two so it's easier if we require to review them.

Comment threaddev/release/post-08-docs.sh
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally with PUSH=0 and it works as expected!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF
AlenkaF requested a review from kouFebruary 5, 2024 12:06
kou
kou approved these changes Feb 6, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 874e596 into apache:mainFeb 6, 2024
@koukou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Feb 6, 2024
@AlenkaF
AlenkaF deleted the gh-39737-update-docs-release-script branch February 6, 2024 08:07
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 874e596.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
apache#39762)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: apache#39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
raulcd added a commit that referenced this pull request Feb 20, 2024
)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: #39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting mergeAwaiting merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website][Docs] index page shows wrong warning bar at top when 15.0 is selected

3 participants

@AlenkaF@kou@raulcd
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-39737: [Release][Docs] Update post release documentation task - #39762

Merged
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script
Feb 6, 2024
Merged

GH-39737: [Release][Docs] Update post release documentation task#39762
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Jan 23, 2024

Copy link
Copy Markdown
Member

This PR updates the dev/release/post-08-docs.sh task so that

  • DOCUMENTATION_OPTIONS.theme_switcher_version_match changes from "" to "{previous_version}"
  • DOCUMENTATION_OPTIONS.show_version_warning_banner changes from false to true

for the documentation that is moved to a subfolder when a new major release is done.

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Jan 23, 2024
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 24, 2024
@AlenkaF
AlenkaF marked this pull request as ready for review January 30, 2024 07:20
@AlenkaF
AlenkaF requested a review from kouJanuary 30, 2024 07:20
kou
kou approved these changes Jan 31, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Just to confirm, did you try this change?

FYI: You can use dry-run by PUSH=0 dev/release/post-08-docs.sh VERSION PREVIOUS_VERSION.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF

Copy link
Copy Markdown
MemberAuthor

No didn't try, had no idea how to :) Will do as you suggest, thank you!

And if it looks good locally, I will go ahead and merge.

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

@kou, can the post release tasks be run (or dry-run) on MacOS?

@kou

kou commented Jan 31, 2024

Copy link
Copy Markdown
Member

Yes. It should work on macOS. Because a release manager may use macOS.

Did you get any error?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, sorry:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
dev/release/post-08-docs.sh: line 48: nproc: command not found
error: switch `j' requires a value

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Oh, could you try the following?

diff --git a/dev/release/post-08-docs.sh b/dev/release/post-08-docs.sh
index f18f7d10c7..a7529fdb2f 100755
--- a/dev/release/post-08-docs.sh+++ b/dev/release/post-08-docs.sh@@ -45,7 +45,16 @@ esac
pushd "${ARROW_SITE_DIR}"
source "${SOURCE_DIR}/git-vars.sh"
-git fetch --all --prune --tags --force -j$(nproc)+n_cpus=1+case $(uname) in+ Linux)+ n_cpus=$(nproc)+ ;;+ Darwin)+ n_cpus=$(sysctl -n hw.logicalcpu)+ ;;+esac+git fetch --all --prune --tags --force -j${n_cpus}
git checkout .
git checkout ${DEFAULT_BRANCH}
git clean -d -f -x

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

The suggested change fixes the issue 👍
Will add it as a commit to this PR if you agree.

I am dealing with next error currently:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': Updated 242 paths from the index
error: Your local changes to the following files would be overwritten by checkout:
docs/1.0/_sources/python/generated/pyarrow.Array.rst.txt
.
.
.
Aborting

Tried adding a fresh clone of arrow-site to see if that helps. Still waiting on this step (looks like it's stuck):

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

Hmm. Could you enable trace log by PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Sure. It still just hangs. Something with my connection to GitHub I guess?

(pyarrow-dev) alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0
+ set -e
+ set -u
+++ dirname dev/release/post-08-docs.sh
++ cd dev/release
++ pwd
+ SOURCE_DIR=/Users/alenkafrim/repos/arrow/dev/release
+ ARROW_DIR=/Users/alenkafrim/repos/arrow/dev/release/../..
+ : /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
+ '[' 2 -ne 2 ']'
+ version=15.0.0
+ previous_version=14.0.0
+ release_tag=apache-arrow-15.0.0
+ branch_name=release-docs-15.0.0
+ case "${version}" in
+ is_major_release=yes
+ pushd /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
~/repos/arrow-site ~/repos/arrow
+ source /Users/alenkafrim/repos/arrow/dev/release/git-vars.sh
+++ git rev-parse --abbrev-ref origin/HEAD
+++ sed s@origin/@@
++ DEFAULT_BRANCH=master
+ n_cpus=1
+ case $(uname) in
++ uname
++ sysctl -n hw.logicalcpu
+ n_cpus=8
+ git fetch --all --prune --tags --force -j8
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

Ah, you need to enter your passphrase for /Users/alenkafrim/.ssh/id_ed25519. Did you enter it?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, I did. First time it worked, now it gets stuck every time ...

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Ha, I tried hitting enter again (twice that is) and got:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
could not fetch 'origin' (exit code: 128)
From github.com:apache/arrow-site
1c75ee2aac8..fb0b8437439 asf-site -> apache/asf-site
87135b28d69..2dc7804b653 main -> apache/main

I just started using ssh key with github so need to check why it is not working. Sorry for the spam!

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

No problem. :-)
You may want to use ssh-agent or something to avoid entering passphrase multiple times.

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested locally and there is one change required (previous_series instead of previous_version) and a couple minor changes in order to split the commits in two so it's easier if we require to review them.

Comment threaddev/release/post-08-docs.sh
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally with PUSH=0 and it works as expected!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF
AlenkaF requested a review from kouFebruary 5, 2024 12:06
kou
kou approved these changes Feb 6, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 874e596 into apache:mainFeb 6, 2024
@koukou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Feb 6, 2024
@AlenkaF
AlenkaF deleted the gh-39737-update-docs-release-script branch February 6, 2024 08:07
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 874e596.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
apache#39762)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: apache#39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
raulcd added a commit that referenced this pull request Feb 20, 2024
)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: #39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting mergeAwaiting merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website][Docs] index page shows wrong warning bar at top when 15.0 is selected

3 participants

@AlenkaF@kou@raulcd
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

GH-39737: [Release][Docs] Update post release documentation task - #39762

Merged
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script
Feb 6, 2024
Merged

GH-39737: [Release][Docs] Update post release documentation task#39762
kou merged 5 commits into
apache:mainfrom
AlenkaF:gh-39737-update-docs-release-script

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Jan 23, 2024

Copy link
Copy Markdown
Member

This PR updates the dev/release/post-08-docs.sh task so that

  • DOCUMENTATION_OPTIONS.theme_switcher_version_match changes from "" to "{previous_version}"
  • DOCUMENTATION_OPTIONS.show_version_warning_banner changes from false to true

for the documentation that is moved to a subfolder when a new major release is done.

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Jan 23, 2024
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 24, 2024
@AlenkaF
AlenkaF marked this pull request as ready for review January 30, 2024 07:20
@AlenkaF
AlenkaF requested a review from kouJanuary 30, 2024 07:20
kou
kou approved these changes Jan 31, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Just to confirm, did you try this change?

FYI: You can use dry-run by PUSH=0 dev/release/post-08-docs.sh VERSION PREVIOUS_VERSION.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF

Copy link
Copy Markdown
MemberAuthor

No didn't try, had no idea how to :) Will do as you suggest, thank you!

And if it looks good locally, I will go ahead and merge.

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

@kou, can the post release tasks be run (or dry-run) on MacOS?

@kou

kou commented Jan 31, 2024

Copy link
Copy Markdown
Member

Yes. It should work on macOS. Because a release manager may use macOS.

Did you get any error?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, sorry:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
dev/release/post-08-docs.sh: line 48: nproc: command not found
error: switch `j' requires a value

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Oh, could you try the following?

diff --git a/dev/release/post-08-docs.sh b/dev/release/post-08-docs.sh
index f18f7d10c7..a7529fdb2f 100755
--- a/dev/release/post-08-docs.sh+++ b/dev/release/post-08-docs.sh@@ -45,7 +45,16 @@ esac
pushd "${ARROW_SITE_DIR}"
source "${SOURCE_DIR}/git-vars.sh"
-git fetch --all --prune --tags --force -j$(nproc)+n_cpus=1+case $(uname) in+ Linux)+ n_cpus=$(nproc)+ ;;+ Darwin)+ n_cpus=$(sysctl -n hw.logicalcpu)+ ;;+esac+git fetch --all --prune --tags --force -j${n_cpus}
git checkout .
git checkout ${DEFAULT_BRANCH}
git clean -d -f -x

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

The suggested change fixes the issue 👍
Will add it as a commit to this PR if you agree.

I am dealing with next error currently:

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': Updated 242 paths from the index
error: Your local changes to the following files would be overwritten by checkout:
docs/1.0/_sources/python/generated/pyarrow.Array.rst.txt
.
.
.
Aborting

Tried adding a fresh clone of arrow-site to see if that helps. Still waiting on this step (looks like it's stuck):

alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 dev/release/post-08-docs.sh 15.0.0 14.0.0 ~/repos/arrow-site ~/repos/arrow
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

Hmm. Could you enable trace log by PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Sure. It still just hangs. Something with my connection to GitHub I guess?

(pyarrow-dev) alenkafrim@Alenkas-MacBook-Pro arrow % PUSH=0 bash -x dev/release/post-08-docs.sh 15.0.0 14.0.0
+ set -e
+ set -u
+++ dirname dev/release/post-08-docs.sh
++ cd dev/release
++ pwd
+ SOURCE_DIR=/Users/alenkafrim/repos/arrow/dev/release
+ ARROW_DIR=/Users/alenkafrim/repos/arrow/dev/release/../..
+ : /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
+ '[' 2 -ne 2 ']'
+ version=15.0.0
+ previous_version=14.0.0
+ release_tag=apache-arrow-15.0.0
+ branch_name=release-docs-15.0.0
+ case "${version}" in
+ is_major_release=yes
+ pushd /Users/alenkafrim/repos/arrow/dev/release/../../../arrow-site
~/repos/arrow-site ~/repos/arrow
+ source /Users/alenkafrim/repos/arrow/dev/release/git-vars.sh
+++ git rev-parse --abbrev-ref origin/HEAD
+++ sed s@origin/@@
++ DEFAULT_BRANCH=master
+ n_cpus=1
+ case $(uname) in
++ uname
++ sysctl -n hw.logicalcpu
+ n_cpus=8
+ git fetch --all --prune --tags --force -j8
Fetching origin
Fetching apache
Enter passphrase for key '/Users/alenkafrim/.ssh/id_ed25519': 

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

Ah, you need to enter your passphrase for /Users/alenkafrim/.ssh/id_ed25519. Did you enter it?

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Yes, I did. First time it worked, now it gets stuck every time ...

@AlenkaF

Copy link
Copy Markdown
MemberAuthor

Ha, I tried hitting enter again (twice that is) and got:

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
could not fetch 'origin' (exit code: 128)
From github.com:apache/arrow-site
1c75ee2aac8..fb0b8437439 asf-site -> apache/asf-site
87135b28d69..2dc7804b653 main -> apache/main

I just started using ssh key with github so need to check why it is not working. Sorry for the spam!

@kou

kou commented Feb 5, 2024

Copy link
Copy Markdown
Member

No problem. :-)
You may want to use ssh-agent or something to avoid entering passphrase multiple times.

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested locally and there is one change required (previous_series instead of previous_version) and a couple minor changes in order to split the commits in two so it's easier if we require to review them.

Comment threaddev/release/post-08-docs.sh
Comment threaddev/release/post-08-docs.sh Outdated
Comment threaddev/release/post-08-docs.sh Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

@raulcdraulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally with PUSH=0 and it works as expected!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF
AlenkaF requested a review from kouFebruary 5, 2024 12:06
kou
kou approved these changes Feb 6, 2024

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 874e596 into apache:mainFeb 6, 2024
@koukou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Feb 6, 2024
@AlenkaF
AlenkaF deleted the gh-39737-update-docs-release-script branch February 6, 2024 08:07
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 874e596.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
apache#39762)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: apache#39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
raulcd added a commit that referenced this pull request Feb 20, 2024
)
This PR updates the `dev/release/post-08-docs.sh` task so that
- `DOCUMENTATION_OPTIONS.theme_switcher_version_match` changes from `""` to `"{previous_version}"` - `DOCUMENTATION_OPTIONS.show_version_warning_banner` changes from `false` to `true`
for the documentation that is moved to a subfolder when a new major release is done.
* Closes: #39737
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting mergeAwaiting merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website][Docs] index page shows wrong warning bar at top when 15.0 is selected

3 participants

@AlenkaF@kou@raulcd