Document workflow for auto submission to Factory #412

perlpunk · 2025-06-16T13:43:16Z

Issue: https://progress.opensuse.org/issues/178105

Summary by Sourcery

Add detailed documentation for the automated OBS submission workflow in the README, outlining the trigger, monitor, and submit/cleanup scripts and the required OBS project setup.

Documentation:

Document the three auto submission scripts (trigger-openqa_in_openqa, monitor-openqa_job, os-autoinst-obs-auto-submit/cleanup-obs-project) for devel:openQA
Describe the OBS project hierarchy (devel:openQA, devel:openQA:testing, devel:openQA:tested) and linking procedures
Explain the job flow: releasing packages to testing, monitoring test results, and submitting packages to openSUSE:Factory

sourcery-ai · 2025-06-16T13:43:21Z

Reviewer's Guide

Added a comprehensive ‘Auto submission scripts for devel:openQA’ section to README.md, outlining the three Jenkins‐driven pipelines (trigger, monitor, submit/cleanup), the OBS project workflow, and usage examples.

Flow diagram for auto submission scripts in devel:openQA

flowchart TD
    A[trigger-openqa_in_openqa] -->|If devel:openQA:testing is empty| B[osc release from devel:openQA to devel:openQA:testing]
    B --> C[Trigger os-autoinst-distri-openqa tests using devel:openQA:testing]
    C --> D[monitor-openqa_job]
    D -->|All jobs passed| E[os-autoinst-obs-auto-submit]
    D -->|Jobs failed| F[Delete packages from devel:openQA:testing]
    E --> G[Submit packages from devel:openQA:tested to openSUSE:Factory]
    E --> H[cleanup-obs-project]
    H --> I[Delete all packages in devel:openQA:testing]

File-Level Changes

Change	Details	Files
Add overview of auto submission scripts and OBS projects	Introduce three scripts/pipelines (trigger, monitor, submit/cleanup) List the three related OBS projects and their roles Explain devel:openQA and devel:openQA:tested linkage and setup	`README.md`
Document trigger-openqa_in_openqa behavior	Describe hourly scheduling of os-autoinst-distri-openqa tests Detail conditional osc release to devel:openQA:testing Explain triggering of tests and logging to job_post_response	`README.md`
Document monitor-openqa_job behavior	Explain monitoring of job_post_response until completion Specify pass/fail branching and cleanup on failure	`README.md`
Document os-autoinst-obs-auto-submit and cleanup	Outline submission of packages to openSUSE:Factory and others Note delay for reviewer window before creating new requests Describe cleanup-obs-project deletion of devel:openQA:testing	`README.md`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

README.md

Related issue: https://progress.opensuse.org/issues/178105

perlpunk · 2025-07-03T15:39:04Z

Addressed a couple of comments

README.md

d3flex · 2025-07-04T07:49:01Z

README.md

+### `monitor-openqa_job`
+
+This monitors `job_post_response` until all jobs are finished. If all jobs
+passed, the auto submit pipeline will be run.


the auto submit pipeline (aka os-autoinst-obs-auto-submit) runs anyway if I am not wrong. it just doesnt do anything. or is it actual skipped if monitoring script failed?

If the monitoring pipeline fails, the following pipeline is not run

README.md

Martchus · 2025-07-04T12:29:14Z

README.md

+
+### `os-autoinst-obs-auto-submit`
+
+This script will copy contents from each `devel:openQA` package to


It will copy packages from devel:openQA:testing, right? Otherwise we might submit something we haven't tested (as new packages might have already ended up in devel:openQA).

The code is really confusing though:

https://github.com/os-autoinst/scripts/blob/master/os-autoinst-obs-auto-submit#L7C1-L7C41

src_project=${src_project:-devel:openQA}

and then only later in the submit function:
https://github.com/os-autoinst/scripts/blob/master/os-autoinst-obs-auto-submit#L231

if [[ -n $staging_project && $staging_project != none && $staging_project != "$src_project" ]]; then src_project=$staging_project must_cleanup_staging=1 fi

If you only look at this line:
https://github.com/os-autoinst/scripts/blob/master/os-autoinst-obs-auto-submit#L202

cp -v "$src_project"/"$package"/* "$dst_project"/"$package"/

then you would think it copies from devel:openQA.

I wonder why it was done this way.

I think it was done this way (probably initially by myself even though the code seems to have gone through quite some changes) because this way I didn't have to change all the lines where src_project is used.

Martchus · 2025-07-04T12:39:34Z

README.md

+
+[devel:openQA](https://build.opensuse.org/project/show/devel:openQA) is the
+project where the packages are automatically updated with every commit in git.
+


Maybe an explanation of devel:openQA:testing here in the middle would be good:

Suggested change

[devel:openQA:testing](https://build.opensuse.org/project/show/devel:openQA:testing) contains

packages currently being tested for submission to `openSUSE:Factory` and potentially other targets

(via `devel:openQA:tested`, see next paragraph). It is only updated by the submission scripts themselves

to remain otherwise unchanged while tests are running and a submission is prepared. (If we would

submit directly from `devel:openQA` we might submit packages that have already changed since tests

were executed so we would not necessarily submit what we have tested.)

Something like that would be also nice 👍

perlpunk force-pushed the autosubmit-docs branch 2 times, most recently from 6ab76e6 to 456d0fb Compare June 18, 2025 12:15

perlpunk changed the title ~~WIP - autosubmit docs~~ Document workflow for auto submission to Factory Jun 18, 2025

perlpunk commented Jun 18, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

okurz requested changes Jun 20, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Document workflow for auto submission to Factory

79dc36b

Related issue: https://progress.opensuse.org/issues/178105

perlpunk force-pushed the autosubmit-docs branch from 456d0fb to 79dc36b Compare July 3, 2025 15:37

perlpunk marked this pull request as ready for review July 3, 2025 15:38

okurz approved these changes Jul 3, 2025

View reviewed changes

d3flex reviewed Jul 4, 2025

View reviewed changes

README.md Show resolved Hide resolved

d3flex reviewed Jul 4, 2025

View reviewed changes

README.md Show resolved Hide resolved

Martchus requested changes Jul 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Document workflow for auto submission to Factory #412

Document workflow for auto submission to Factory #412

Uh oh!

perlpunk commented Jun 16, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot commented Jun 16, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

perlpunk commented Jul 3, 2025 •

edited

Loading

Uh oh!

Uh oh!

d3flex Jul 4, 2025

Uh oh!

perlpunk Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

Martchus Jul 4, 2025

Uh oh!

perlpunk Jul 4, 2025

Uh oh!

Martchus Jul 5, 2025 •

edited

Loading

Uh oh!

Martchus Jul 4, 2025

Uh oh!

d3flex Jul 7, 2025

Uh oh!

Uh oh!


		### `os-autoinst-obs-auto-submit`

		This script will copy contents from each `devel:openQA` package to


		[devel:openQA](https://build.opensuse.org/project/show/devel:openQA) is the
		project where the packages are automatically updated with every commit in git.

+[devel:openQA:testing](https://build.opensuse.org/project/show/devel:openQA:testing) contains
+packages currently being tested for submission to `openSUSE:Factory` and potentially other targets
+(via `devel:openQA:tested`, see next paragraph). It is only updated by the submission scripts themselves
+to remain otherwise unchanged while tests are running and a submission is prepared. (If we would
+submit directly from `devel:openQA`  we might submit packages that have already changed since tests
+were executed so we would not necessarily submit what we have tested.)

Document workflow for auto submission to Factory #412

Are you sure you want to change the base?

Document workflow for auto submission to Factory #412

Uh oh!

Conversation

perlpunk commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Flow diagram for auto submission scripts in devel:openQA

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

perlpunk commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

d3flex Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

perlpunk Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Martchus Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

perlpunk Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

Martchus Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Martchus Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

d3flex Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

perlpunk commented Jun 16, 2025 •

edited

Loading

sourcery-ai bot commented Jun 16, 2025 •

edited

Loading

perlpunk commented Jul 3, 2025 •

edited

Loading

Martchus Jul 5, 2025 •

edited

Loading