Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Feb 6, 2024

Conversation

AlenkaF
Copy link
Member

@AlenkaF AlenkaF commented Jan 23, 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.

@github-actions github-actions bot added the awaiting review Awaiting review label Jan 23, 2024
dev/release/post-08-docs.sh Outdated Show resolved Hide resolved
dev/release/post-08-docs.sh Outdated Show resolved Hide resolved
dev/release/post-08-docs.sh Outdated Show resolved Hide resolved
@github-actions github-actions bot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting review Awaiting review labels Jan 23, 2024
@github-actions github-actions bot added awaiting review Awaiting review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Jan 24, 2024
@github-actions github-actions bot 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 kou January 30, 2024 07:20
Copy link
Member

@kou kou left a comment

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-actions github-actions bot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Jan 31, 2024
@AlenkaF
Copy link
Member Author

AlenkaF commented Jan 31, 2024

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
Member Author

AlenkaF commented Jan 31, 2024

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

@kou
Copy link
Member

kou commented Jan 31, 2024

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

Did you get any error?

@AlenkaF
Copy link
Member Author

AlenkaF commented Jan 31, 2024

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
Copy link
Member

kou commented Feb 1, 2024

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
Member Author

AlenkaF commented Feb 2, 2024

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
Copy link
Member

kou commented Feb 2, 2024

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
Member Author

AlenkaF commented Feb 5, 2024

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
Copy link
Member

kou commented Feb 5, 2024

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

@AlenkaF
Copy link
Member Author

AlenkaF commented Feb 5, 2024

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

@AlenkaF
Copy link
Member Author

AlenkaF commented Feb 5, 2024

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

[email protected]: 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
Copy link
Member

kou commented Feb 5, 2024

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

Copy link
Member

@raulcd raulcd left a comment

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.

dev/release/post-08-docs.sh Show resolved Hide resolved
dev/release/post-08-docs.sh Outdated Show resolved Hide resolved
dev/release/post-08-docs.sh Outdated Show resolved Hide resolved
@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Feb 5, 2024
@github-actions github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024
Copy link
Member

@raulcd raulcd left a comment

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-actions github-actions bot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024
@AlenkaF AlenkaF requested a review from kou February 5, 2024 12:06
Copy link
Member

@kou kou left a comment

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:main Feb 6, 2024
7 checks passed
@kou kou removed the awaiting merge Awaiting merge label Feb 6, 2024
@github-actions github-actions bot 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
Copy link

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 <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Raúl Cumplido <[email protected]>
Co-authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
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 <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Raúl Cumplido <[email protected]>
Co-authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
zanmato1984 pushed a commit to zanmato1984/arrow that referenced this pull request Feb 28, 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 <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Raúl Cumplido <[email protected]>
Co-authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
thisisnic pushed a commit to thisisnic/arrow that referenced this pull request Mar 8, 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 <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Raúl Cumplido <[email protected]>
Co-authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting merge Awaiting 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