Skip to content

Commit 81b4f61

Browse files
authored
add API and link to svn:dist area (#648)
1 parent e9ed2a3 commit 81b4f61

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

atr/templates/about.html

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,22 @@ <h1>About ATR</h1>
3434
<h2>Release functionality</h2>
3535

3636
<p>
37-
For Alpha v2, the ATR allows users to start votes by sending the vote initiation email to their own mailing lists. Announcements of finished releases, however, must still be performed manually using dist SVN as usual.
37+
For Alpha v2, the ATR allows users to start votes by sending the vote initiation email to their own mailing lists. Announcements of finished releases, however, must still be performed manually using <a href="https://dist.apache.org/repos/dist/release/"><code>svn:dist/release</code></a> as usual.
3838
</p>
3939

4040
<h2>Release process</h2>
4141

4242
<p>
43-
The following table compares the UI, CLI, and GitHub actions for each step in the release process. Variables <code>P</code>, <code>V</code>, and <code>R</code> represent the project, version, and revision of a release, respectively.
43+
The following table compares <a href="https://release-test.apache.org/tutorial">the UI</a>, <a href="https://github.com/apache/tooling-releases-client"><code>atr</code> CLI</a>, and <a href="https://github.com/apache/tooling-actions"><code>apache/tooling-actions/*</code> GitHub actions</a> for each step in the release process. Variables <code>P</code>, <code>V</code>, and <code>R</code> represent the project, version, and revision of a release, respectively.
4444
</p>
4545

4646
<table class="table table-bordered table-striped">
4747
<tr>
4848
<th>Step</th>
49-
<th>UI</th>
50-
<th>CLI</th>
51-
<th>GitHub</th>
49+
<th><a href="https://release-test.apache.org/tutorial">UI</a></th>
50+
<th><a href="https://github.com/apache/tooling-releases-client/blob/main/COMMANDS.md">CLI</a></th>
51+
<th><a href="https://github.com/apache/tooling-actions">GHA</a></th>
52+
<th><a href="/api/docs">API</a></th>
5253
</tr>
5354
<tr>
5455
<th class="step">Start a release</th>
@@ -59,6 +60,9 @@ <h2>Release process</h2>
5960
<code>atr release start P V</code>
6061
</td>
6162
<td class="github">-</td>
63+
<td class="api">
64+
<code>/api/release/create</code>
65+
</td>
6266
</tr>
6367
<tr>
6468
<th class="step">Upload files</th>
@@ -69,6 +73,9 @@ <h2>Release process</h2>
6973
<code>atr upload P V path file</code>
7074
</td>
7175
<td class="github">tooling-actions/upload-to-atr</td>
76+
<td class="api">
77+
<code>/api/release/upload</code>
78+
</td>
7279
</tr>
7380
<tr>
7481
<th class="step">Wait for checks</th>
@@ -77,6 +84,7 @@ <h2>Release process</h2>
7784
<code>atr check wait P V</code>
7885
</td>
7986
<td class="github">-</td>
87+
<td class="api">-</td>
8088
</tr>
8189
<tr>
8290
<th class="step">Review checks</th>
@@ -87,6 +95,7 @@ <h2>Release process</h2>
8795
<code>atr check status P V</code>
8896
</td>
8997
<td class="github">-</td>
98+
<td class="api">-</td>
9099
</tr>
91100
<tr>
92101
<th class="step">Record test distribution</th>
@@ -97,6 +106,7 @@ <h2>Release process</h2>
97106
<code>atr distribution record P V plat owner pkg ver stg details</code>
98107
</td>
99108
<td class="github">tooling-actions/record-atr-distribution</td>
109+
<td class="api">-</td>
100110
</tr>
101111
<tr>
102112
<th class="step">Start voting</th>
@@ -107,6 +117,9 @@ <h2>Release process</h2>
107117
<code>atr vote start P V R -m email</code>
108118
</td>
109119
<td class="github">-</td>
120+
<td class="api">
121+
<code>/api/vote/start</code>
122+
</td>
110123
</tr>
111124
<tr>
112125
<th class="step">Resolve vote</th>
@@ -117,6 +130,9 @@ <h2>Release process</h2>
117130
<code>atr vote resolve P V passed</code>
118131
</td>
119132
<td class="github">tooling-actions/release-on-atr</td>
133+
<td class="api">
134+
<code>/api/vote/resolve</code>
135+
</td>
120136
</tr>
121137
<tr>
122138
<th class="step">Record distribution</th>
@@ -127,6 +143,9 @@ <h2>Release process</h2>
127143
<code>atr distribution record P V plat owner pkg ver stg details</code>
128144
</td>
129145
<td class="github">tooling-actions/record-atr-distribution</td>
146+
<td class="api">
147+
<code>/api/publisher/distribution/record</code>
148+
</td>
130149
</tr>
131150
<tr>
132151
<th class="step">Announce release</th>
@@ -137,13 +156,17 @@ <h2>Release process</h2>
137156
<code>atr announce P V R -m email -s subject -b body</code>
138157
</td>
139158
<td class="github">tooling-actions/release-on-atr</td>
159+
<td class="api">
160+
<code>/api/release/announce</code>
161+
</td>
140162
</tr>
141163
<!--
142164
<tr>
143165
<th class="step"></th>
144166
<td class="ui"><code></code></td>
145167
<td class="cli"><code></code></td>
146168
<td class="github"></td>
169+
<td class="api"></td>
147170
</tr>
148171
-->
149172
</table>

0 commit comments

Comments
 (0)