Skip to content
Permalink
Browse files
Update site for Avatica-Go 5.1.0 release
  • Loading branch information
F21 committed Mar 27, 2022
1 parent c89cbd5 commit 3c297b1c5c0a7b2cf4499672dd87b99fde7ea1ac
Showing 47 changed files with 662 additions and 164 deletions.
@@ -103,8 +103,8 @@ <h2 id="issues">Issues</h2>

<h2 id="updating-protobuf-definitions">Updating protobuf definitions</h2>
<ol>
<li>Install <a href="https://docs.docker.com/install/">docker</a> and <a href="https://docs.docker.com/compose/install/">docker-compose</a>.</li>
<li>From the root of the repository, run <code class="highlighter-rouge">docker-compose run compile-protobuf</code></li>
<li>Install <a href="https://docs.docker.com/install/">docker</a> and <a href="https://docs.docker.com/compose/install/">docker compose</a>.</li>
<li>From the root of the repository, run <code class="highlighter-rouge">docker compose run compile-protobuf</code></li>
</ol>

<h2 id="live-reload-during-development">Live reload during development</h2>
@@ -115,13 +115,13 @@ <h2 id="live-reload-during-development">Live reload during development</h2>
<h3 id="set-up">Set up</h3>
<ol>
<li>
<p>Install <a href="https://docs.docker.com/install/">docker</a> and <a href="https://docs.docker.com/compose/install/">docker-compose</a>.</p>
<p>Install <a href="https://docs.docker.com/install/">docker</a> and <a href="https://docs.docker.com/compose/install/">docker compose</a>.</p>
</li>
<li>
<p>From the root of the repository, run <code class="highlighter-rouge">docker-compose run dev</code>.</p>
<p>From the root of the repository, run <code class="highlighter-rouge">docker compose run dev</code>.</p>
</li>
<li>
<p>After terminating the container, stop all the containers and remove them using: <code class="highlighter-rouge">docker-compose down</code></p>
<p>After terminating the container, stop all the containers and remove them using: <code class="highlighter-rouge">docker compose down</code></p>
</li>
</ol>

@@ -131,13 +131,13 @@ <h2 id="testing">Testing</h2>
<h3 id="easy-way">Easy way</h3>
<ol>
<li>
<p>Install <a href="https://docs.docker.com/install/">docker</a> and <a href="https://docs.docker.com/compose/install/">docker-compose</a>.</p>
<p>Install <a href="https://docs.docker.com/install/">docker</a> and <a href="https://docs.docker.com/compose/install/">docker compose</a>.</p>
</li>
<li>
<p>From the root of the repository, run <code class="highlighter-rouge">docker-compose run test</code>.</p>
<p>From the root of the repository, run <code class="highlighter-rouge">docker compose run test</code>.</p>
</li>
<li>
<p>After the tests complete, stop all the containers and remove them using: <code class="highlighter-rouge">docker-compose down</code></p>
<p>After the tests complete, stop all the containers and remove them using: <code class="highlighter-rouge">docker compose down</code></p>
</li>
</ol>

@@ -182,7 +182,7 @@ <h3 id="manual-set-up">Manual set up</h3>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -193,7 +193,7 @@ <h2 id="getting-started">Getting started</h2>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -121,7 +121,7 @@ <h1>Developing Avatica Components</h1>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1124,7 +1124,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1050,7 +1050,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1083,7 +1083,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1105,7 +1105,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1217,7 +1217,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -706,6 +706,46 @@ <h1>Go Client History</h1>
Downloads are available on the
<a href="/avatica/downloads/avatica-go.html">downloads page</a>.</p>

<h2 id="v5-1-0"><a href="https://github.com/apache/calcite-avatica-go/releases/tag/v5.1.0">5.1.0</a> / 2022-03-27</h2>

<p>Apache Calcite Avatica Go 5.1.0 is a maintenance release of Avatica Go with some dependency updates and bug fixes.
This release supports Go 1.17 and 1.18, which are currently the versions supported and maintained by the Go team.</p>

<p>The protobuf library <a href="https://github.com/golang/protobuf">github.com/golang/protobuf</a> was replaced by
<a href="https://pkg.go.dev/google.golang.org/protobuf">google.golang.org/protobuf</a>, which is the successor and replacement for
the former. In addition, the <a href="https://pkg.go.dev/golang.org/x/xerrors">golang.org/x/xerrors</a> package has been replaced with
the standard library’s built-in <a href="https://pkg.go.dev/errors">errors</a> package as the features in the experimental <code class="highlighter-rouge">xerrors</code>
package have been available in the standard library’s <code class="highlighter-rouge">errors</code> package since Go 1.13.</p>

<p>Contributors to this release:
Francis Chuang, Josiah Goodson</p>

<p>Features and bug fixes</p>

<ul>
<li>[<a href="https://issues.apache.org/jira/browse/CALCITE-4174">CALCITE-4174</a>]
avatica-go should handle complex/long URLs</li>
<li>[<a href="https://issues.apache.org/jira/browse/CALCITE-5057">CALCITE-5057</a>]
Switch from github.com/golang/protobuf to google.golang.org/protobuf</li>
<li>[<a href="https://issues.apache.org/jira/browse/CALCITE-5058">CALCITE-5058</a>]
Upgrade dependencies and tidy go.mod</li>
<li>[<a href="https://issues.apache.org/jira/browse/CALCITE-5063">CALCITE-5063</a>]
Replace golang.org/x/xerrors package with errors package in stdlib</li>
</ul>

<p>Tests</p>

<ul>
<li>[<a href="https://issues.apache.org/jira/browse/CALCITE-4299">CALCITE-4299</a>]
Test against Go 1.14 and 1.15</li>
<li>[<a href="https://issues.apache.org/jira/browse/CALCITE-5055">CALCITE-5055</a>]
Test against Go 1.17 and 1.18</li>
<li>[<a href="https://issues.apache.org/jira/browse/CALCITE-5056">CALCITE-5056</a>]
Test against avatica 1.18 - 1.20</li>
<li>[<a href="https://issues.apache.org/jira/browse/CALCITE-5059">CALCITE-5059</a>]
Update Github Actions to latest versions</li>
</ul>

<h2 id="v5-0-0"><a href="https://github.com/apache/calcite-avatica-go/releases/tag/v5.0.0">5.0.0</a> / 2020-07-16</h2>

<p>Apache Calcite Avatica Go 5.0.0 is a major release of Avatica Go with a number of improvements and a breaking change.
@@ -1235,7 +1275,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -755,18 +755,18 @@ <h3 id="perform-a-dry-run">Perform a dry-run</h3>
</ul>

<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="c"># On Linux:</span>
docker-compose run <span class="nt">-v</span> ~/.gnupg:/.gnupg dry-run
docker compose run <span class="nt">-v</span> ~/.gnupg:/.gnupg dry-run

<span class="c"># On Windows</span>
docker-compose run <span class="nt">-v</span> /c/Users/username/AppData/Roaming/gnupg:/.gnupg dry-run</code></pre></figure>
docker compose run <span class="nt">-v</span> /c/Users/username/AppData/Roaming/gnupg:/.gnupg dry-run</code></pre></figure>

<h3 id="build-the-release">Build the release</h3>

<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="c"># On Linux:</span>
docker-compose run <span class="nt">-v</span> ~/.gnupg:/.gnupg release
docker compose run <span class="nt">-v</span> ~/.gnupg:/.gnupg release

<span class="c"># On Windows</span>
docker-compose run <span class="nt">-v</span> /c/Users/username/AppData/Roaming/gnupg:/.gnupg release</code></pre></figure>
docker compose run <span class="nt">-v</span> /c/Users/username/AppData/Roaming/gnupg:/.gnupg release</code></pre></figure>

<p>If the build fails, perform a clean:</p>
<ol>
@@ -780,7 +780,7 @@ <h3 id="build-the-release">Build the release</h3>
<li>Clean the local repository</li>
</ol>

<figure class="highlight"><pre><code class="language-bash" data-lang="bash">docker-compose run clean</code></pre></figure>
<figure class="highlight"><pre><code class="language-bash" data-lang="bash">docker compose run clean</code></pre></figure>

<h3 id="check-the-release-before-uploading">Check the release before uploading</h3>
<p>The name of the release folder must be in the following format: <code class="highlighter-rouge">apache-calcite-avatica-go-X.Y.Z-rcN</code>. The version must
@@ -822,7 +822,7 @@ <h4 id="manually">Manually</h4>
<h4 id="using-docker">Using docker</h4>
<p>This assumes that a release was built and the artifacts are in the <code class="highlighter-rouge">dist/</code> folder.</p>

<figure class="highlight"><pre><code class="language-bash" data-lang="bash">docker-compose run publish-release-for-voting</code></pre></figure>
<figure class="highlight"><pre><code class="language-bash" data-lang="bash">docker compose run publish-release-for-voting</code></pre></figure>

<p>The script will also generate a vote email to send to the dev list. You can use this email, but make sure to check that
all the details are correct.</p>
@@ -861,10 +861,10 @@ <h3 id="send-an-email-to-the-dev-list-for-voting">Send an email to the Dev list

Please vote on releasing this package as Apache Calcite Avatica Go X.Y.Z.

To run the tests without a Go environment, install docker and docker-compose. Then, in the root of the release's directory, run:
docker-compose run test
To run the tests without a Go environment, install docker and docker compose. Then, in the root of the release's directory, run:
docker compose run test

When the test suite completes, run \"docker-compose down\" to remove and shutdown all the containers.
When the test suite completes, run \"docker compose down\" to remove and shutdown all the containers.

The vote is open for the next 72 hours and passes if a majority of
at least three +1 PMC votes are cast.
@@ -938,7 +938,7 @@ <h4 id="manually-1">Manually</h4>
<h4 id="using-docker-1">Using docker</h4>
<p>This assumes that a rc release was tagged and pushed to the git repository.</p>

<figure class="highlight"><pre><code class="language-bash" data-lang="bash">docker-compose run promote-release</code></pre></figure>
<figure class="highlight"><pre><code class="language-bash" data-lang="bash">docker compose run promote-release</code></pre></figure>

<h3 id="announce-the-release">Announce the release</h3>
<p>After 24 hours, announce the release by sending an announcement to the <a href="https://mail-archives.apache.org/mod_mbox/calcite-dev/">dev list</a>
@@ -1268,7 +1268,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -2056,7 +2056,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1462,7 +1462,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1136,7 +1136,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -2124,7 +2124,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -2240,7 +2240,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1041,7 +1041,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -995,7 +995,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -1266,7 +1266,7 @@ <h4>Avatica Go Client Meta</h4>
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
@@ -94,6 +94,12 @@ <h2 id="source-releases">Source releases</h2>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left"><a href="/avatica/docs/go_history.html#v5-1-0">5.1.0</a></td>
<td style="text-align: left">27 Mar 2022</td>
<td style="text-align: left"><a href="https://github.com/apache/calcite-avatica-go/commit/c232d7b">c232d7b</a></td>
<td style="text-align: left"><a href="https://www.apache.org/dyn/closer.lua?filename=calcite/apache-calcite-avatica-go-5.1.0/apache-calcite-avatica-go-5.1.0-src.tar.gz&amp;action=download">tar</a> (<a href="https://downloads.apache.org/calcite/apache-calcite-avatica-go-5.1.0/apache-calcite-avatica-go-5.1.0-src.tar.gz.sha512">sha512</a> <a href="https://downloads.apache.org/calcite/apache-calcite-avatica-go-5.1.0/apache-calcite-avatica-go-5.1.0-src.tar.gz.asc">pgp</a>)</td>
</tr>
<tr>
<td style="text-align: left"><a href="/avatica/docs/go_history.html#v5-0-0">5.0.0</a></td>
<td style="text-align: left">16 Jul 2020</td>
@@ -181,7 +187,7 @@ <h2 id="verify-the-integrity-of-the-files">Verify the integrity of the files</h2
<img src="/avatica/img/feather.png" width="190" height="77" alt="Apache Logo"></a>
</div>
<div id="copyright">
<p>The contents of this website are &copy;&nbsp;2021
<p>The contents of this website are &copy;&nbsp;2022
<a href="https://www.apache.org/">Apache Software Foundation</a>
under the terms of
the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">

0 comments on commit 3c297b1

Please sign in to comment.