Skip to content

feat(RELEASE-1675): auto generate README.md files for tasks/pipelines#1147

Closed
Paul123111 wants to merge 1 commit into
konflux-ci:developmentfrom
Paul123111:auto-readme
Closed

feat(RELEASE-1675): auto generate README.md files for tasks/pipelines#1147
Paul123111 wants to merge 1 commit into
konflux-ci:developmentfrom
Paul123111:auto-readme

Conversation

@Paul123111

Copy link
Copy Markdown
Contributor

Describe your changes

Add readme_generator.sh, which generates README.md files for tasks and pipelines, as well as a check_readme.sh script and workflow to check that the README.md files in each task and pipeline match the output of readme-generator.sh.

Also updated all README.md files using this script.

Relevant Jira

https://issues.redhat.com/browse/RELEASE-1675

Checklist before requesting a review

  • I have marked as draft or added do not merge label if there's a dependency PR
    • If you want reviews on your draft PR, you can add reviewers or add the release-service-maintainers handle if you are unsure who to tag
  • My commit message includes Signed-off-by: My name <email>
  • I read CONTRIBUTING.MD and commit formatting

@Paul123111

Copy link
Copy Markdown
Contributor Author

/retest

2 similar comments
@Paul123111

Copy link
Copy Markdown
Contributor Author

/retest

@Paul123111

Copy link
Copy Markdown
Contributor Author

/retest

Add readme_generator.sh, which generates README.md files
for tasks and pipelines, as well as a check_readme.sh script and
workflow to check that the README.md files in each task and pipeline
match the output of readme-generator.sh.

Also updated all README.md files using this script.

Signed-off-by: Paul Fitzgerald <pafitzge@redhat.com>
@konflux-ci-qe-bot

Copy link
Copy Markdown

@Paul123111: The following test has Failed, say /retest to rerun failed tests.

PipelineRun Name Status Rerun command Build Log Test Log
konflux-e2e-tests-catalog-8qz5s Failed /retest View Pipeline Log View Test Logs

Inspecting Test Artifacts

To inspect your test artifacts, follow these steps:

  1. Install ORAS (see the ORAS installation guide).
  2. Download artifacts with the following commands:
mkdir -p oras-artifacts
cd oras-artifacts
oras pull quay.io/konflux-test-storage/konflux-team/release-service-catalog:konflux-e2e-tests-catalog-8qz5s

Test results analysis

🚨 Error occurred while running the E2E tests, list of failed Spec(s):

➡️ [failed] [It] [release-pipelines-suite e2e tests for multi arch with rh-advisories pipeline] Multi arch test happy path Post-release verification verifies the multiarch release pipelinerun is running and succeeds [release-pipelines, rh-advisories, multiarch-advisories, multiArchAdvisories]

Click to view logs

PipelineRun managed-pg2pg failed
Expected
    : Pipelinerun 'managed-pg2pg' didn't succeed\nLogs from failed container 'managed-pg2pg-create-pyxis-image/step-create-trusted-artifact': \n2025/07/02 11:13:16 Skipping step because a previous step failed\n
to equal
    : 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants