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 1a38326 Move the page about checks to a dedicated page about tasks
1a38326 is described below
commit 1a3832660981ef719be332b296cf93aead762856
Author: Sean B. Palmer <[email protected]>
AuthorDate: Fri Oct 24 15:11:39 2025 +0100
Move the page about checks to a dedicated page about tasks
---
atr/docs/build-processes.html | 6 ++--
atr/docs/build-processes.md | 6 ++--
atr/docs/code-conventions.html | 6 ++--
atr/docs/code-conventions.md | 6 ++--
atr/docs/developer-guide.html | 9 +++---
atr/docs/developer-guide.md | 10 +++----
atr/docs/how-to-contribute.html | 4 +--
atr/docs/how-to-contribute.md | 6 ++--
atr/docs/index.html | 9 +++---
atr/docs/index.md | 10 +++----
atr/docs/running-and-creating-tests.html | 6 ++--
atr/docs/running-and-creating-tests.md | 6 ++--
atr/docs/tasks.html | 50 ++++++++++++++++++++++++++++++++
atr/docs/{adding-checks.md => tasks.md} | 23 ++++++++-------
atr/docs/user-interface.html | 2 +-
atr/docs/user-interface.md | 2 +-
16 files changed, 108 insertions(+), 53 deletions(-)
diff --git a/atr/docs/build-processes.html b/atr/docs/build-processes.html
index 6a5f1cb..6ef5075 100644
--- a/atr/docs/build-processes.html
+++ b/atr/docs/build-processes.html
@@ -1,7 +1,7 @@
-<h1 id="build-processes">3.6. Build processes</h1>
+<h1 id="build-processes">3.7. Build processes</h1>
<p><strong>Up</strong>: <code>3.</code> <a href="developer-guide">Developer
guide</a></p>
-<p><strong>Prev</strong>: <code>3.5.</code> <a href="user-interface">User
interface</a></p>
-<p><strong>Next</strong>: <code>3.7.</code> <a
href="running-and-creating-tests">Running and creating tests</a></p>
+<p><strong>Prev</strong>: <code>3.6.</code> <a href="tasks">Tasks</a></p>
+<p><strong>Next</strong>: <code>3.8.</code> <a
href="running-and-creating-tests">Running and creating tests</a></p>
<p><strong>Sections</strong>:</p>
<ul>
<li><a href="#documentation-build-script">Documentation build script</a></li>
diff --git a/atr/docs/build-processes.md b/atr/docs/build-processes.md
index b910b10..1dd20c7 100644
--- a/atr/docs/build-processes.md
+++ b/atr/docs/build-processes.md
@@ -1,10 +1,10 @@
-# 3.6. Build processes
+# 3.7. Build processes
**Up**: `3.` [Developer guide](developer-guide)
-**Prev**: `3.5.` [User interface](user-interface)
+**Prev**: `3.6.` [Tasks](tasks)
-**Next**: `3.7.` [Running and creating tests](running-and-creating-tests)
+**Next**: `3.8.` [Running and creating tests](running-and-creating-tests)
**Sections**:
diff --git a/atr/docs/code-conventions.html b/atr/docs/code-conventions.html
index b09fb1f..95ede86 100644
--- a/atr/docs/code-conventions.html
+++ b/atr/docs/code-conventions.html
@@ -1,7 +1,7 @@
-<h1 id="code-conventions">3.8. Code conventions</h1>
+<h1 id="code-conventions">3.9. Code conventions</h1>
<p><strong>Up</strong>: <code>3.</code> <a href="developer-guide">Developer
guide</a></p>
-<p><strong>Prev</strong>: <code>3.7.</code> <a
href="running-and-creating-tests">Running and creating tests</a></p>
-<p><strong>Next</strong>: <code>3.9.</code> <a href="how-to-contribute">How to
contribute</a></p>
+<p><strong>Prev</strong>: <code>3.8.</code> <a
href="running-and-creating-tests">Running and creating tests</a></p>
+<p><strong>Next</strong>: <code>3.10.</code> <a href="how-to-contribute">How
to contribute</a></p>
<p><strong>Sections</strong>:</p>
<ul>
<li><a href="#python-code">Python code</a></li>
diff --git a/atr/docs/code-conventions.md b/atr/docs/code-conventions.md
index 32df343..19bdaf6 100644
--- a/atr/docs/code-conventions.md
+++ b/atr/docs/code-conventions.md
@@ -1,10 +1,10 @@
-# 3.8. Code conventions
+# 3.9. Code conventions
**Up**: `3.` [Developer guide](developer-guide)
-**Prev**: `3.7.` [Running and creating tests](running-and-creating-tests)
+**Prev**: `3.8.` [Running and creating tests](running-and-creating-tests)
-**Next**: `3.9.` [How to contribute](how-to-contribute)
+**Next**: `3.10.` [How to contribute](how-to-contribute)
**Sections**:
diff --git a/atr/docs/developer-guide.html b/atr/docs/developer-guide.html
index 967ca82..f6e3f98 100644
--- a/atr/docs/developer-guide.html
+++ b/atr/docs/developer-guide.html
@@ -9,10 +9,11 @@
<li><code>3.3.</code> <a href="database">Database</a></li>
<li><code>3.4.</code> <a href="storage-interface">Storage interface</a></li>
<li><code>3.5.</code> <a href="user-interface">User interface</a></li>
-<li><code>3.6.</code> <a href="build-processes">Build processes</a></li>
-<li><code>3.7.</code> <a href="running-and-creating-tests">Running and
creating tests</a></li>
-<li><code>3.8.</code> <a href="code-conventions">Code conventions</a></li>
-<li><code>3.9.</code> <a href="how-to-contribute">How to contribute</a></li>
+<li><code>3.6.</code> <a href="tasks">Tasks</a></li>
+<li><code>3.7.</code> <a href="build-processes">Build processes</a></li>
+<li><code>3.8.</code> <a href="running-and-creating-tests">Running and
creating tests</a></li>
+<li><code>3.9.</code> <a href="code-conventions">Code conventions</a></li>
+<li><code>3.10.</code> <a href="how-to-contribute">How to contribute</a></li>
</ul>
<p><strong>Sections</strong>:</p>
<ul>
diff --git a/atr/docs/developer-guide.md b/atr/docs/developer-guide.md
index 7fe9197..6eb4917 100644
--- a/atr/docs/developer-guide.md
+++ b/atr/docs/developer-guide.md
@@ -13,11 +13,11 @@
* `3.3.` [Database](database)
* `3.4.` [Storage interface](storage-interface)
* `3.5.` [User interface](user-interface)
-* `3.6.` [Build processes](build-processes)
-* `3.7.` [Running and creating tests](running-and-creating-tests)
-* `3.8.` [Code conventions](code-conventions)
-* `3.9.` [How to contribute](how-to-contribute)
- * `3.9.1.` [Adding checks](adding-checks)
+* `3.6.` [Tasks](tasks)
+* `3.7.` [Build processes](build-processes)
+* `3.8.` [Running and creating tests](running-and-creating-tests)
+* `3.9.` [Code conventions](code-conventions)
+* `3.10.` [How to contribute](how-to-contribute)
**Sections**:
diff --git a/atr/docs/how-to-contribute.html b/atr/docs/how-to-contribute.html
index bc31425..ca36ef8 100644
--- a/atr/docs/how-to-contribute.html
+++ b/atr/docs/how-to-contribute.html
@@ -1,6 +1,6 @@
-<h1 id="how-to-contribute">3.9. How to contribute</h1>
+<h1 id="how-to-contribute">3.10. How to contribute</h1>
<p><strong>Up</strong>: <code>3.</code> <a href="developer-guide">Developer
guide</a></p>
-<p><strong>Prev</strong>: <code>3.8.</code> <a href="code-conventions">Code
conventions</a></p>
+<p><strong>Prev</strong>: <code>3.9.</code> <a href="code-conventions">Code
conventions</a></p>
<p><strong>Next</strong>: (none)</p>
<p><strong>Sections</strong>:</p>
<ul>
diff --git a/atr/docs/how-to-contribute.md b/atr/docs/how-to-contribute.md
index b0ffb81..569476a 100644
--- a/atr/docs/how-to-contribute.md
+++ b/atr/docs/how-to-contribute.md
@@ -1,10 +1,10 @@
-# 3.9. How to contribute
+# 3.10. How to contribute
**Up**: `3.` [Developer guide](developer-guide)
-**Prev**: `3.8.` [Code conventions](code-conventions)
+**Prev**: `3.9.` [Code conventions](code-conventions)
-**Next**: `3.9.1.` [Adding checks](adding-checks)
+**Next**: (none)
**Sections**:
diff --git a/atr/docs/index.html b/atr/docs/index.html
index dd9c88b..a043467 100644
--- a/atr/docs/index.html
+++ b/atr/docs/index.html
@@ -12,10 +12,11 @@
<li><code>3.3.</code> <a href="database">Database</a></li>
<li><code>3.4.</code> <a href="storage-interface">Storage interface</a></li>
<li><code>3.5.</code> <a href="user-interface">User interface</a></li>
-<li><code>3.6.</code> <a href="build-processes">Build processes</a></li>
-<li><code>3.7.</code> <a href="running-and-creating-tests">Running and
creating tests</a></li>
-<li><code>3.8.</code> <a href="code-conventions">Code conventions</a></li>
-<li><code>3.9.</code> <a href="how-to-contribute">How to contribute</a></li>
+<li><code>3.6.</code> <a href="tasks">Tasks</a></li>
+<li><code>3.7.</code> <a href="build-processes">Build processes</a></li>
+<li><code>3.8.</code> <a href="running-and-creating-tests">Running and
creating tests</a></li>
+<li><code>3.9.</code> <a href="code-conventions">Code conventions</a></li>
+<li><code>3.10.</code> <a href="how-to-contribute">How to contribute</a></li>
</ul>
</li>
</ul>
diff --git a/atr/docs/index.md b/atr/docs/index.md
index 5beb393..70eaca7 100644
--- a/atr/docs/index.md
+++ b/atr/docs/index.md
@@ -14,8 +14,8 @@ NOTE: This documentation is a work in progress.
* `3.3.` [Database](database)
* `3.4.` [Storage interface](storage-interface)
* `3.5.` [User interface](user-interface)
- * `3.6.` [Build processes](build-processes)
- * `3.7.` [Running and creating tests](running-and-creating-tests)
- * `3.8.` [Code conventions](code-conventions)
- * `3.9.` [How to contribute](how-to-contribute)
- * `3.9.1.` [Adding checks](adding-checks)
+ * `3.6.` [Tasks](tasks)
+ * `3.7.` [Build processes](build-processes)
+ * `3.8.` [Running and creating tests](running-and-creating-tests)
+ * `3.9.` [Code conventions](code-conventions)
+ * `3.10.` [How to contribute](how-to-contribute)
diff --git a/atr/docs/running-and-creating-tests.html
b/atr/docs/running-and-creating-tests.html
index d9aeea7..c957c65 100644
--- a/atr/docs/running-and-creating-tests.html
+++ b/atr/docs/running-and-creating-tests.html
@@ -1,7 +1,7 @@
-<h1 id="running-and-creating-tests">3.7. Running and creating tests</h1>
+<h1 id="running-and-creating-tests">3.8. Running and creating tests</h1>
<p><strong>Up</strong>: <code>3.</code> <a href="developer-guide">Developer
guide</a></p>
-<p><strong>Prev</strong>: <code>3.6.</code> <a href="build-processes">Build
processes</a></p>
-<p><strong>Next</strong>: <code>3.8.</code> <a href="code-conventions">Code
conventions</a></p>
+<p><strong>Prev</strong>: <code>3.7.</code> <a href="build-processes">Build
processes</a></p>
+<p><strong>Next</strong>: <code>3.9.</code> <a href="code-conventions">Code
conventions</a></p>
<p><strong>Sections</strong>:</p>
<ul>
<li><a href="#running-tests">Running tests</a></li>
diff --git a/atr/docs/running-and-creating-tests.md
b/atr/docs/running-and-creating-tests.md
index 1a79bae..aca85c1 100644
--- a/atr/docs/running-and-creating-tests.md
+++ b/atr/docs/running-and-creating-tests.md
@@ -1,10 +1,10 @@
-# 3.7. Running and creating tests
+# 3.8. Running and creating tests
**Up**: `3.` [Developer guide](developer-guide)
-**Prev**: `3.6.` [Build processes](build-processes)
+**Prev**: `3.7.` [Build processes](build-processes)
-**Next**: `3.8.` [Code conventions](code-conventions)
+**Next**: `3.9.` [Code conventions](code-conventions)
**Sections**:
diff --git a/atr/docs/tasks.html b/atr/docs/tasks.html
new file mode 100644
index 0000000..165c513
--- /dev/null
+++ b/atr/docs/tasks.html
@@ -0,0 +1,50 @@
+<h1 id="tasks">3.6. Tasks</h1>
+<p><strong>Up</strong>: <code>3.</code> <a href="developer-guide">Developer
guide</a></p>
+<p><strong>Prev</strong>: <code>3.5.</code> <a href="user-interface">User
interface</a></p>
+<p><strong>Next</strong>: <code>3.7.</code> <a href="build-processes">Build
processes</a></p>
+<p><strong>Sections</strong>:</p>
+<ul>
+<li><a href="#introduction">Introduction</a></li>
+<li><a href="#checks">Checks</a></li>
+</ul>
+<h2 id="introduction">Introduction</h2>
+<p>Tasks are computations run in the background in dedicated worker processes
orchestrated by a manager.</p>
+<h2 id="checks">Checks</h2>
+<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>
+</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>
+<h3 id="importing-and-using-a-check-module">Importing and using a check
module</h3>
+<p>In <code>atr/tasks/__init__.py</code> you will see imports for existing
modules where you can add an import for new check task, for example:</p>
+<pre><code class="language-python">import atr.tasks.checks.hashing as hashing
+import atr.tasks.checks.license as license
+</code></pre>
+<p>And in the <code>resolve</code> function you will see where those modules
are exercised where you can add a <code>case</code> statement for the new
task:</p>
+<pre><code class="language-python">def resolve(task_type: sql.TaskType) ->
Callable[..., Awaitable[results.Results | None]]: # noqa: C901
+ match task_type:
+ case sql.TaskType.HASHING_CHECK:
+ return hashing.check
+ case sql.TaskType.KEYS_IMPORT_FILE:
+ return keys.import_file
+ case sql.TaskType.LICENSE_FILES:
+ return license.files
+ case sql.TaskType.LICENSE_HEADERS:
+ return license.headers
+</code></pre>
+<h3 id="defining-a-task-type">Defining a task type</h3>
+<p>In <code>atr/models/sql.py</code> you will find the <code>TaskType</code>
class where you can add a new mapping for the task:</p>
+<pre><code class="language-python">class TaskType(str, enum.Enum):
+ HASHING_CHECK = "hashing_check"
+ KEYS_IMPORT_FILE = "keys_import_file"
+ LICENSE_FILES = "license_files"
+ LICENSE_HEADERS = "license_headers"
+</code></pre>
diff --git a/atr/docs/adding-checks.md b/atr/docs/tasks.md
similarity index 76%
rename from atr/docs/adding-checks.md
rename to atr/docs/tasks.md
index 30e8d45..fd45d55 100644
--- a/atr/docs/adding-checks.md
+++ b/atr/docs/tasks.md
@@ -1,18 +1,24 @@
-# 3.9.1. Adding checks
+# 3.6. Tasks
**Up**: `3.` [Developer guide](developer-guide)
-**Prev**: `3.9.` [How to contribute](how-to-contribute)
+**Prev**: `3.5.` [User interface](user-interface)
-**Next**: (none)
+**Next**: `3.7.` [Build processes](build-processes)
**Sections**:
* [Introduction](#introduction)
-* [Where to add code](#where-to-add-code)
+* [Checks](#checks)
## Introduction
+Tasks are computations run in the background in dedicated worker processes
orchestrated by a manager.
+
+## Checks
+
+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.
+
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
@@ -23,14 +29,11 @@ There are several checks for correctness that are already
built out, and this ho
1. Well-formed tarballs
1. Well-formed zip files
-
-## Where to add code
-
-### Adding your task check module
+### Adding a task check module
In `atr/tasks/checks` you will find several modules that perform these check
tasks, including `hashing.py`, `license.py`, etc. To write a new check task,
add a module here that performs the checks needed.
-### Importing and using your module
+### Importing and using a check module
In `atr/tasks/__init__.py` you will see imports for existing modules where you
can add an import for new check task, for example:
@@ -54,7 +57,7 @@ def resolve(task_type: sql.TaskType) -> Callable[...,
Awaitable[results.Results
return license.headers
```
-### Defining your task type
+### Defining a task type
In `atr/models/sql.py` you will find the `TaskType` class where you can add a
new mapping for the task:
diff --git a/atr/docs/user-interface.html b/atr/docs/user-interface.html
index c7ce898..0e098df 100644
--- a/atr/docs/user-interface.html
+++ b/atr/docs/user-interface.html
@@ -1,7 +1,7 @@
<h1 id="user-interface">3.5. User interface</h1>
<p><strong>Up</strong>: <code>3.</code> <a href="developer-guide">Developer
guide</a></p>
<p><strong>Prev</strong>: <code>3.4.</code> <a
href="storage-interface">Storage interface</a></p>
-<p><strong>Next</strong>: <code>3.6.</code> <a href="build-processes">Build
processes</a></p>
+<p><strong>Next</strong>: <code>3.6.</code> <a href="tasks">Tasks</a></p>
<p><strong>Sections</strong>:</p>
<ul>
<li><a href="#introduction">Introduction</a></li>
diff --git a/atr/docs/user-interface.md b/atr/docs/user-interface.md
index 2638e52..8d46ce4 100644
--- a/atr/docs/user-interface.md
+++ b/atr/docs/user-interface.md
@@ -4,7 +4,7 @@
**Prev**: `3.4.` [Storage interface](storage-interface)
-**Next**: `3.6.` [Build processes](build-processes)
+**Next**: `3.6.` [Tasks](tasks)
**Sections**:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
