Skip to content

Update release process to use Python 3 for Python API documentation #122

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.

Sign up for GitHub

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

Merged
asfgit merged 1 commit into from
Jul 11, 2018
Merged

Update release process to use Python 3 for Python API documentation #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ Instead much of the same release logic can be accessed in `dev/create-release/re
- R, for CRAN packaging tests, requires e1071 to be installed as part of the packaging tests.
- In addition R uses LaTeX for some things, and requires some additional fonts. On Debian based systems you may wish to install `texlive-fonts-recommended` and `texlive-fonts-extra`.
- Make sure you required Python packages for packaging (see `dev/requirements.txt`)
Copy link
Member

@felixcheung felixcheung Jul 9, 2018

Choose a reason for hiding this comment

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

should we put that (sphinx) into dev/requirements.txt?

Copy link
Member Author

@HyukjinKwon HyukjinKwon Jul 9, 2018

Choose a reason for hiding this comment

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

Indeed yea I think we should.

- Ensure you have Python 3 having Sphinx installed, and `SPHINXPYTHON` environment variable is set to indicate your Python 3 executable (see SPARK-24530).
- Tag the release candidate with `dev/create-release/release-tag.sh` (e.g. for creating 2.1.2 RC2 we did `ASF_USERNAME=holden ASF_PASSWORD=yoursecretgoeshere GIT_NAME="Holden Karau" GIT_BRANCH=branch-2.1 GIT_EMAIL="holden@us.ibm.com" RELEASE_VERSION=2.1.2 RELEASE_TAG=v2.1.2-rc2 NEXT_VERSION=2.1.3-SNAPSHOT ./dev/create-release/release-tag.sh`)
- Package the release binaries & sources with `dev/create-release/release-build.sh package`
- Create the release docs with `dev/create-release/release-build.sh docs`
Expand Down
1 change: 1 addition & 0 deletions site/release-process.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ <h3>Cutting a Release Candidate</h3>
<li>R, for CRAN packaging tests, requires e1071 to be installed as part of the packaging tests.</li>
<li>In addition R uses LaTeX for some things, and requires some additional fonts. On Debian based systems you may wish to install <code>texlive-fonts-recommended</code> and <code>texlive-fonts-extra</code>.</li>
<li>Make sure you required Python packages for packaging (see <code>dev/requirements.txt</code>)</li>
<li>Ensure you have Python 3 having Sphinx installed, and <code>SPHINXPYTHON</code> environment variable is set to indicate your Python 3 executable (see SPARK-24530).</li>
<li>Tag the release candidate with <code>dev/create-release/release-tag.sh</code> (e.g. for creating 2.1.2 RC2 we did <code>ASF_USERNAME=holden ASF_PASSWORD=yoursecretgoeshere GIT_NAME="Holden Karau" GIT_BRANCH=branch-2.1 GIT_EMAIL="holden@us.ibm.com" RELEASE_VERSION=2.1.2 RELEASE_TAG=v2.1.2-rc2 NEXT_VERSION=2.1.3-SNAPSHOT ./dev/create-release/release-tag.sh</code>)</li>
<li>Package the release binaries &amp; sources with <code>dev/create-release/release-build.sh package</code></li>
<li>Create the release docs with <code>dev/create-release/release-build.sh docs</code></li>
Expand Down