This is an automated email from the ASF dual-hosted git repository.
sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-trusted-releases.git
The following commit(s) were added to refs/heads/main by this push:
new 14148b6 Add more information about specific checks
14148b6 is described below
commit 14148b6a8fedf37697d353e235c50a5966f44087
Author: Sean B. Palmer <[email protected]>
AuthorDate: Fri Oct 24 15:17:45 2025 +0100
Add more information about specific checks
---
atr/docs/tasks.html | 17 ++++++++++-------
atr/docs/tasks.md | 17 ++++++++++-------
2 files changed, 20 insertions(+), 14 deletions(-)
diff --git a/atr/docs/tasks.html b/atr/docs/tasks.html
index 165c513..518aa8e 100644
--- a/atr/docs/tasks.html
+++ b/atr/docs/tasks.html
@@ -13,13 +13,16 @@
<p>One important subset of task in ATR is the check. Checks are run when a
release manager adds or modifies files in a release candidate draft. The
outputs of the checks alert the release manager to potential issues.</p>
<p>There are several checks for correctness that are already built out, and
this how-to provides pointers for developers wishing to add new checks for
relevant pieces of a release. Currently as of <code>alpha-2</code> ATR has
checks for the following:</p>
<ol>
-<li>Correct hashing</li>
-<li>Compliant license</li>
-<li>File paths</li>
-<li>RAT results</li>
-<li>Correct signature</li>
-<li>Well-formed tarballs</li>
-<li>Well-formed zip files</li>
+<li>Correct hashing (<code>sql.TaskType.HASHING_CHECK</code>,
<code>hashing.check</code>)</li>
+<li>Compliant license (<code>sql.TaskType.LICENSE_FILES</code>,
<code>license.files</code>)</li>
+<li>Compliant license headers (<code>sql.TaskType.LICENSE_HEADERS</code>,
<code>license.headers</code>)</li>
+<li>File paths (<code>sql.TaskType.PATHS_CHECK</code>,
<code>paths.check</code>)</li>
+<li>RAT results (<code>sql.TaskType.RAT_CHECK</code>,
<code>rat.check</code>)</li>
+<li>Correct signature (<code>sql.TaskType.SIGNATURE_CHECK</code>,
<code>signature.check</code>)</li>
+<li>Tarball integrity (<code>sql.TaskType.TARGZ_INTEGRITY</code>,
<code>targz.integrity</code>)</li>
+<li>Tarball structure (<code>sql.TaskType.TARGZ_STRUCTURE</code>,
<code>targz.structure</code>)</li>
+<li>Zip file integrity (<code>sql.TaskType.ZIPFORMAT_INTEGRITY</code>,
<code>zipformat.integrity</code>)</li>
+<li>Zip file structure (<code>sql.TaskType.ZIPFORMAT_STRUCTURE</code>,
<code>zipformat.structure</code>)</li>
</ol>
<h3 id="adding-a-task-check-module">Adding a task check module</h3>
<p>In <code>atr/tasks/checks</code> you will find several modules that perform
these check tasks, including <code>hashing.py</code>, <code>license.py</code>,
etc. To write a new check task, add a module here that performs the checks
needed.</p>
diff --git a/atr/docs/tasks.md b/atr/docs/tasks.md
index fd45d55..98c409a 100644
--- a/atr/docs/tasks.md
+++ b/atr/docs/tasks.md
@@ -21,13 +21,16 @@ One important subset of task in ATR is the check. Checks
are run when a release
There are several checks for correctness that are already built out, and this
how-to provides pointers for developers wishing to add new checks for relevant
pieces of a release. Currently as of `alpha-2` ATR has checks for the following:
-1. Correct hashing
-1. Compliant license
-1. File paths
-1. RAT results
-1. Correct signature
-1. Well-formed tarballs
-1. Well-formed zip files
+1. Correct hashing (`sql.TaskType.HASHING_CHECK`, `hashing.check`)
+1. Compliant license (`sql.TaskType.LICENSE_FILES`, `license.files`)
+1. Compliant license headers (`sql.TaskType.LICENSE_HEADERS`,
`license.headers`)
+1. File paths (`sql.TaskType.PATHS_CHECK`, `paths.check`)
+1. RAT results (`sql.TaskType.RAT_CHECK`, `rat.check`)
+1. Correct signature (`sql.TaskType.SIGNATURE_CHECK`, `signature.check`)
+1. Tarball integrity (`sql.TaskType.TARGZ_INTEGRITY`, `targz.integrity`)
+1. Tarball structure (`sql.TaskType.TARGZ_STRUCTURE`, `targz.structure`)
+1. Zip file integrity (`sql.TaskType.ZIPFORMAT_INTEGRITY`,
`zipformat.integrity`)
+1. Zip file structure (`sql.TaskType.ZIPFORMAT_STRUCTURE`,
`zipformat.structure`)
### Adding a task check module
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
