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

ARROW-15601: [Docs][Release] Update post release script to move stable docs + keep dev docs #12355

Closed

Conversation

jorisvandenbossche
Copy link
Member

@jorisvandenbossche jorisvandenbossche commented Feb 7, 2022

This updates the post-release script for the docs with:

  • keep the /docs/dev docs
  • move the current stable docs (without all versioned + dev docs subdirectories) to a new versioned subdirectory

@github-actions
Copy link

github-actions bot commented Feb 7, 2022

@jorisvandenbossche
Copy link
Member Author

One thing I just realized is that the "move current stable to previous version" logic only needs to happen for a major release, and not when doing a bug-fix release (eg 7.0.1). So that logic should maybe be behind a flag (eg based on whether the second "previous_version" parameter was specified?)

@apache apache deleted a comment from github-actions bot Feb 7, 2022
@kou
Copy link
Member

kou commented Feb 7, 2022

How about checking the minor and patch version in the first argument?

case "${version}" in
  *.0.0)
    is_major_release=yes
    ;;
  *)
    is_major_release=no
    ;;
esac

If we need to change the number of arguments depending on context, a human error will occur.

@jorisvandenbossche
Copy link
Member Author

@kou thanks for the suggestion!

dev/release/post-09-docs.sh Outdated Show resolved Hide resolved
dev/release/post-09-docs.sh Outdated Show resolved Hide resolved
dev/release/post-09-docs.sh Outdated Show resolved Hide resolved
git add docs
git commit -m "[Website] Update documentations for ${version}"
git clean -d -f -x
Copy link
Member

Choose a reason for hiding this comment

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

Is this needed?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not strictly "needed" for the creating the correct PR, but the script does leave a bunch of ignored files after running it locally (eg we don't commit the .doctrees files), and including this ensures it cleans up after itself. I could also limit it to the /docs/ directory (or remove it altogether)

Copy link
Member

Choose a reason for hiding this comment

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

Ah, I see.

@jorisvandenbossche
Copy link
Member Author

Sorry for the delay here, this should be ready now I think

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 closed this in 8963755 Apr 7, 2022
@jorisvandenbossche jorisvandenbossche deleted the ARROW-15601 branch April 7, 2022 11:44
@ursabot
Copy link

ursabot commented Apr 7, 2022

Benchmark runs are scheduled for baseline = c4c5c03 and contender = 8963755. 8963755 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Finished ⬇️0.08% ⬆️0.25%] test-mac-arm
[Failed ⬇️0.36% ⬆️1.43%] ursa-i9-9960x
[Finished ⬇️0.64% ⬆️0.0%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/459| 8963755f ec2-t3-xlarge-us-east-2>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/444| 8963755f test-mac-arm>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/445| 8963755f ursa-i9-9960x>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/454| 8963755f ursa-thinkcentre-m75q>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/458| c4c5c032 ec2-t3-xlarge-us-east-2>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/443| c4c5c032 test-mac-arm>
[Failed] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/444| c4c5c032 ursa-i9-9960x>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/453| c4c5c032 ursa-thinkcentre-m75q>
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

jcralmeida pushed a commit to rafael-telles/arrow that referenced this pull request Apr 19, 2022
…e docs + keep dev docs

This updates the post-release script for the docs with:

- keep the `/docs/dev` docs
- move the current stable docs (without all versioned + dev docs subdirectories) to a new versioned subdirectory

Closes apache#12355 from jorisvandenbossche/ARROW-15601

Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants