mbox series

[v3,0/3] Add a script to create series artifacts

Message ID 20240118234120.29256-1-ahassick@iol.unh.edu (mailing list archive)
Headers
Series Add a script to create series artifacts |

Message

Adam Hassick Jan. 18, 2024, 11:41 p.m. UTC 
  The process of applying patches and bundling the source code into an
archive varies across testing labs. Historically, the process for
applying patches at the Community Lab was not visible to the broader
community and was inextricable from lab infrastructure. The new script
introduced in this patch aims to resolve these issues. This script is
intended to serve as a reference process for creating series artifacts.
A "series artifact" is an archive containing a copy of the DPDK source
code with a patch series applied. We perform a test build prior to
creating the archive as well. At the Community Lab, these archives are
used for all of our tests. At the time of writing, this script is being
used in production.

The script depends on the "pw_maintainers_cli" and patch parser scripts
in the CI repository. It also depends on pygit2 for managing the DPDK
repository, pyyaml for parsing the configuration file, and git_pw for
pulling in the series as a patch file.

This script does not implement handling of the dependency labels. There
is an ongoing effort to get this implemented into Patchwork as a
feature.
---

v1:
* Add script to create artifacts
* Add example config file

v2:
* Add a branch mapping from tree names to branches on GitHub
* Untangled dataclass and argument parsing code
* Add retry loop around cloning the repository
* Removed a couple subprocess calls
* Add an example to the description text

v3:
* Split parse_args into two distinct functions
* Refactor set_properties and its calls
* Add doc directory
* Add document describing the create artifact script
* Add SPDX license specifiers

Adam Hassick (3):
  tools: Add script to create artifacts
  config: Add example config file
  doc: Add documentation

 config/artifacts.yml            |  24 ++
 doc/create_series_artifact.rst  | 103 +++++++
 tools/create_series_artifact.py | 468 ++++++++++++++++++++++++++++++++
 3 files changed, 595 insertions(+)
 create mode 100644 config/artifacts.yml
 create mode 100644 doc/create_series_artifact.rst
 create mode 100755 tools/create_series_artifact.py

Comments

Aaron Conole Feb. 22, 2024, 7:25 p.m. UTC | #1 
Adam Hassick <ahassick@iol.unh.edu> writes:

> The process of applying patches and bundling the source code into an
> archive varies across testing labs. Historically, the process for
> applying patches at the Community Lab was not visible to the broader
> community and was inextricable from lab infrastructure. The new script
> introduced in this patch aims to resolve these issues. This script is
> intended to serve as a reference process for creating series artifacts.
> A "series artifact" is an archive containing a copy of the DPDK source
> code with a patch series applied. We perform a test build prior to
> creating the archive as well. At the Community Lab, these archives are
> used for all of our tests. At the time of writing, this script is being
> used in production.
>
> The script depends on the "pw_maintainers_cli" and patch parser scripts
> in the CI repository. It also depends on pygit2 for managing the DPDK
> repository, pyyaml for parsing the configuration file, and git_pw for
> pulling in the series as a patch file.
>
> This script does not implement handling of the dependency labels. There
> is an ongoing effort to get this implemented into Patchwork as a
> feature.
> ---

Marged - thanks!