This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-adbc.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 00007ec publish documentation
00007ec is described below
commit 00007ec049071f9cff5c3646bca67f81a2dde682
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Sun Dec 25 16:54:30 2022 +0000
publish documentation
---
0.1.0/temp/_sources/development/releasing.rst.txt | 20 ++++++++++++++------
0.1.0/temp/development/releasing.html | 17 ++++++++++-------
0.1.0/temp/searchindex.js | 2 +-
3 files changed, 25 insertions(+), 14 deletions(-)
diff --git a/0.1.0/temp/_sources/development/releasing.rst.txt
b/0.1.0/temp/_sources/development/releasing.rst.txt
index c6e1768..637d711 100644
--- a/0.1.0/temp/_sources/development/releasing.rst.txt
+++ b/0.1.0/temp/_sources/development/releasing.rst.txt
@@ -50,6 +50,8 @@ Some steps of the release require being a committer or a PMC
member.
# You might need to export GPG_TTY=$(tty) to properly prompt for a
passphrase
mvn clean install -Papache-release
+- An `Artifactory`_ API key (log in with your ASF credentials, then generate
it from your profile in the upper-right). You must set the Artifactory API key
in ``dev/release/.env`` (see ``dev/release/.env.example`` for a template).
+
- Install ``en_US.UTF-8`` locale. You can confirm available locales by
``locale -a``.
- Install Conda with conda-forge, and create and activate the environment.
@@ -59,6 +61,12 @@ Some steps of the release require being a committer or a PMC
member.
This will install two tools used in the release process: ``commitizen``
(generates changelog from commit messages) and ``gh`` (submit jobs/download
artifacts).
+- Install Docker.
+
+- Clone the main Arrow repository (https://github.com/apache/arrow) and
symlink ``arrow-adbc/dev/release/.env`` to ``arrow/dev/release/.env``. Some
release scripts depend on the scripts in the main Arrow repository.
+
+.. _Artifactory: https://apache.jfrog.io
+
Before creating a Release Candidate
===================================
@@ -105,12 +113,12 @@ Create or update the corresponding maintenance branch
.. code-block::
- # First cherry-pick any commits by hand.
git switch maint-X.Y.Z
+ # Remove the commits that created the changelog and bumped the
+ # versions, since 01-source.sh will redo those steps
+ git reset --hard HEAD~2
+ # Cherry-pick any commits by hand.
git cherry-pick ...
- # Revert the commit that created the changelog so we can
- # regenerate it in 01-source.sh
- git revert <CHANGELOG COMMIT>
# Push the updated maintenance branch to the remote repository
git push -u apache maint-X.Y.Z
@@ -131,7 +139,7 @@ Create the Release Candidate tag from the updated
maintenance branch
dev/release/01-prepare.sh <version> <next-version> <rc-number>
- git push -u apache apache-arrow-adbc-<version>-rc<rc-number>
+ git push -u apache apache-arrow-adbc-<version>-rc<rc-number> maint-<version>
Build source and binaries and submit them
-----------------------------------------
@@ -154,7 +162,7 @@ Build source and binaries and submit them
# Note that you need to press the "Close" button manually by Web interface
# after you complete the script:
# https://repository.apache.org/#stagingRepositories
- dev/release/04-java-upload.sh <version> <rc-number>
+ dev/release/04-java-upload.sh <arrow-dir> <version> <rc-number>
# Sign and upload the deb/rpm packages and APT/Yum repositories
#
diff --git a/0.1.0/temp/development/releasing.html
b/0.1.0/temp/development/releasing.html
index 4d7c065..58bd65f 100644
--- a/0.1.0/temp/development/releasing.html
+++ b/0.1.0/temp/development/releasing.html
@@ -347,6 +347,7 @@ performing a release.</p>
</pre></div>
</div>
</li>
+<li><p>An <a class="reference external"
href="https://apache.jfrog.io">Artifactory</a> API key (log in with your ASF
credentials, then generate it from your profile in the upper-right). You must
set the Artifactory API key in <code class="docutils literal notranslate"><span
class="pre">dev/release/.env</span></code> (see <code class="docutils literal
notranslate"><span class="pre">dev/release/.env.example</span></code> for a
template).</p></li>
<li><p>Install <code class="docutils literal notranslate"><span
class="pre">en_US.UTF-8</span></code> locale. You can confirm available locales
by <code class="docutils literal notranslate"><span class="pre">locale</span>
<span class="pre">-a</span></code>.</p></li>
<li><p>Install Conda with conda-forge, and create and activate the
environment.</p>
<div class="highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="n">mamba</span> <span
class="n">create</span> <span class="o">-</span><span class="n">n</span> <span
class="n">adbc</span> <span class="o">-</span><span class="n">c</span> <span
class="n">conda</span><span class="o">-</span><span class="n">forge</span>
<span class="o">--</span><span class="n">file</span> <span
class="n">ci</span><span class="o">/</span><span
class="n">conda_env_dev</span><spa [...]
@@ -354,6 +355,8 @@ performing a release.</p>
</div>
<p>This will install two tools used in the release process: <code
class="docutils literal notranslate"><span class="pre">commitizen</span></code>
(generates changelog from commit messages) and <code class="docutils literal
notranslate"><span class="pre">gh</span></code> (submit jobs/download
artifacts).</p>
</li>
+<li><p>Install Docker.</p></li>
+<li><p>Clone the main Arrow repository (<a class="reference external"
href="https://github.com/apache/arrow">https://github.com/apache/arrow</a>) and
symlink <code class="docutils literal notranslate"><span
class="pre">arrow-adbc/dev/release/.env</span></code> to <code class="docutils
literal notranslate"><span class="pre">arrow/dev/release/.env</span></code>.
Some release scripts depend on the scripts in the main Arrow
repository.</p></li>
</ul>
</section>
<section id="before-creating-a-release-candidate">
@@ -395,12 +398,12 @@ Initial Release Candidate</label><div
class="sd-tab-content docutils">
<input id="sd-tab-item-1" name="sd-tab-set-0" type="radio">
</input><label class="sd-tab-label" for="sd-tab-item-1">
Follow up Release Candidates</label><div class="sd-tab-content docutils">
-<div class="highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="c1"># First cherry-pick any
commits by hand.</span>
-<span class="n">git</span> <span class="n">switch</span> <span
class="n">maint</span><span class="o">-</span><span class="n">X</span><span
class="o">.</span><span class="n">Y</span><span class="o">.</span><span
class="n">Z</span>
+<div class="highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="n">git</span> <span
class="n">switch</span> <span class="n">maint</span><span
class="o">-</span><span class="n">X</span><span class="o">.</span><span
class="n">Y</span><span class="o">.</span><span class="n">Z</span>
+<span class="c1"># Remove the commits that created the changelog and bumped
the</span>
+<span class="c1"># versions, since 01-source.sh will redo those steps</span>
+<span class="n">git</span> <span class="n">reset</span> <span
class="o">--</span><span class="n">hard</span> <span class="n">HEAD</span><span
class="o">~</span><span class="mi">2</span>
+<span class="c1"># Cherry-pick any commits by hand.</span>
<span class="n">git</span> <span class="n">cherry</span><span
class="o">-</span><span class="n">pick</span> <span class="o">...</span>
-<span class="c1"># Revert the commit that created the changelog so we
can</span>
-<span class="c1"># regenerate it in 01-source.sh</span>
-<span class="n">git</span> <span class="n">revert</span> <span
class="o"><</span><span class="n">CHANGELOG</span> <span
class="n">COMMIT</span><span class="o">></span>
<span class="c1"># Push the updated maintenance branch to the remote
repository</span>
<span class="n">git</span> <span class="n">push</span> <span
class="o">-</span><span class="n">u</span> <span class="n">apache</span> <span
class="n">maint</span><span class="o">-</span><span class="n">X</span><span
class="o">.</span><span class="n">Y</span><span class="o">.</span><span
class="n">Z</span>
</pre></div>
@@ -422,7 +425,7 @@ Follow up Release Candidates</label><div
class="sd-tab-content docutils">
<span class="n">dev</span><span class="o">/</span><span
class="n">release</span><span class="o">/</span><span class="mi">01</span><span
class="o">-</span><span class="n">prepare</span><span class="o">.</span><span
class="n">sh</span> <span class="o"><</span><span
class="n">version</span><span class="o">></span> <span
class="o"><</span><span class="nb">next</span><span class="o">-</span><span
class="n">version</span><span class="o">></span> <span
class="o"><</span><span cla [...]
-<span class="n">git</span> <span class="n">push</span> <span
class="o">-</span><span class="n">u</span> <span class="n">apache</span> <span
class="n">apache</span><span class="o">-</span><span
class="n">arrow</span><span class="o">-</span><span class="n">adbc</span><span
class="o">-<</span><span class="n">version</span><span
class="o">>-</span><span class="n">rc</span><span class="o"><</span><span
class="n">rc</span><span class="o">-</span><span class="n">number</span><span
clas [...]
+<span class="n">git</span> <span class="n">push</span> <span
class="o">-</span><span class="n">u</span> <span class="n">apache</span> <span
class="n">apache</span><span class="o">-</span><span
class="n">arrow</span><span class="o">-</span><span class="n">adbc</span><span
class="o">-<</span><span class="n">version</span><span
class="o">>-</span><span class="n">rc</span><span class="o"><</span><span
class="n">rc</span><span class="o">-</span><span class="n">number</span><span
clas [...]
</pre></div>
</div>
</section>
@@ -444,7 +447,7 @@ Follow up Release Candidates</label><div
class="sd-tab-content docutils">
<span class="c1"># Note that you need to press the "Close" button
manually by Web interface</span>
<span class="c1"># after you complete the script:</span>
<span class="c1"># https://repository.apache.org/#stagingRepositories</span>
-<span class="n">dev</span><span class="o">/</span><span
class="n">release</span><span class="o">/</span><span class="mi">04</span><span
class="o">-</span><span class="n">java</span><span class="o">-</span><span
class="n">upload</span><span class="o">.</span><span class="n">sh</span> <span
class="o"><</span><span class="n">version</span><span class="o">></span>
<span class="o"><</span><span class="n">rc</span><span
class="o">-</span><span class="n">number</span><span class="o">&g [...]
+<span class="n">dev</span><span class="o">/</span><span
class="n">release</span><span class="o">/</span><span class="mi">04</span><span
class="o">-</span><span class="n">java</span><span class="o">-</span><span
class="n">upload</span><span class="o">.</span><span class="n">sh</span> <span
class="o"><</span><span class="n">arrow</span><span class="o">-</span><span
class="nb">dir</span><span class="o">></span> <span
class="o"><</span><span class="n">version</span><span class="o">& [...]
<span class="c1"># Sign and upload the deb/rpm packages and APT/Yum
repositories</span>
<span class="c1">#</span>
diff --git a/0.1.0/temp/searchindex.js b/0.1.0/temp/searchindex.js
index e883f4e..125b40a 100644
--- a/0.1.0/temp/searchindex.js
+++ b/0.1.0/temp/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["cpp/api/adbc", "cpp/api/adbc_driver_manager",
"cpp/api/index", "cpp/concurrency", "cpp/driver_manager", "cpp/index",
"development/contributing", "development/nightly", "development/releasing",
"driver/cpp/features", "driver/cpp/flight_sql", "driver/cpp/index",
"driver/cpp/postgresql", "driver/cpp/sqlite", "driver/java/flight_sql",
"driver/java/index", "driver/java/jdbc", "format/comparison",
"format/specification", "format/versioning", "go/index", "index", [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["cpp/api/adbc", "cpp/api/adbc_driver_manager",
"cpp/api/index", "cpp/concurrency", "cpp/driver_manager", "cpp/index",
"development/contributing", "development/nightly", "development/releasing",
"driver/cpp/features", "driver/cpp/flight_sql", "driver/cpp/index",
"driver/cpp/postgresql", "driver/cpp/sqlite", "driver/java/flight_sql",
"driver/java/index", "driver/java/jdbc", "format/comparison",
"format/specification", "format/versioning", "go/index", "index", [...]
\ No newline at end of file