Add markdown table output of missing examples to docs #712

elliotgunton · 2023-07-18T08:36:53Z

Pull Request Checklist

Tracking Add more upstream Argo Workflows examples #567
~~Tests added~~ Fixed missing examples test
Documentation/examples added
Good commit messages and/or PR title

Description of PR
There was a missing minus when creating the list of argo_examples, so the list of missing examples had broken links. This PR fixes the links and adds it as a markdown table to the examples page https://hera--712.org.readthedocs.build/en/712/examples/workflows-examples/#list-of-missing-examples

Signed-off-by: Elliot Gunton <[email protected]>

codecov · 2023-07-18T08:38:45Z

Codecov Report

Merging #712 (771491a) into main (8485446) will not change coverage.
The diff coverage is n/a.

❗ Current head 771491a differs from pull request most recent head 4b2617a. Consider uploading reports for the commit 4b2617a to get more accurate results

@@          Coverage Diff          @@
##            main    #712   +/-   ##
=====================================
  Coverage   77.4%   77.4%           
=====================================
  Files         45      45           
  Lines       3346    3346           
  Branches     639     639           
=====================================
  Hits        2592    2592           
  Misses       576     576           
  Partials     178     178

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Signed-off-by: Elliot Gunton <[email protected]>

tests/test_remaining_examples.py

flaviuvadan · 2023-07-18T13:21:53Z

docs/examples/workflows-examples.md

 The "Hera" collection shows off features and idiomatic usage of Hera such as the
 [Coinflip example](workflows/coinflip.md) using the script decorator.
+
+## List of missing examples


@elliotgunton for my own clarity, these were manually copy/pasted here, right?

Yep, but that's a good idea to automate alongside make regenerate-test-data 👀

@flaviuvadan done! List is now sorted and autogenerated at the end of make regenerate-test-data

flaviuvadan

🎖️

Signed-off-by: Elliot Gunton <[email protected]>

Bumps [pytest-cov](https://github.com/pytest-dev/pytest-cov) from 6.2.1 to 7.0.0. <details> <summary>Changelog</summary> Sourced from <a href="https://github.com/pytest-dev/pytest-cov/blob/master/CHANGELOG.rst">pytest-cov's changelog</a>. <blockquote> <h2>7.0.0 (2025-09-09)</h2> <ul> <li> Dropped support for subprocesses measurement. It was a feature added long time ago when coverage lacked a nice way to measure subprocesses created in tests. It relied on a <code>.pth</code> file, there was no way to opt-out and it created bad interations with <code>coverage's new patch system <https://coverage.readthedocs.io/en/latest/config.html#run-patch></code>_ added in <code>7.10 <https://coverage.readthedocs.io/en/7.10.6/changes.html#version-7-10-0-2025-07-24></code>_. To migrate to this release you might need to enable the suprocess patch, example for <code>.coveragerc</code>: .. code-block:: ini [run] patch = subprocess This release also requires at least coverage 7.10.6. </li> <li> Switched packaging to have metadata completely in <code>pyproject.toml</code> and use <code>hatchling <https://pypi.org/project/hatchling/></code>_ for building. Contributed by Ofek Lev in <code>[#551](pytest-dev/pytest-cov#551) <https://github.com/pytest-dev/pytest-cov/pull/551></code>_ with some extras in <code>[#716](pytest-dev/pytest-cov#716) <https://github.com/pytest-dev/pytest-cov/pull/716></code>_. </li> <li> Removed some not really necessary testing deps like <code>six</code>. </li> </ul> <h2>6.3.0 (2025-09-06)</h2> <ul> <li>Added support for markdown reports. Contributed by Marcos Boger in <code>[#712](pytest-dev/pytest-cov#712) <https://github.com/pytest-dev/pytest-cov/pull/712></code>_ and <code>[#714](pytest-dev/pytest-cov#714) <https://github.com/pytest-dev/pytest-cov/pull/714></code>_.</li> <li>Fixed some formatting issues in docs. Anonymous contribution in <code>[#706](pytest-dev/pytest-cov#706) <https://github.com/pytest-dev/pytest-cov/pull/706></code>_.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/224d8964caad90074a8cf6dc8720b8f70f31629b"><code>224d896</code></a> Bump version: 6.3.0 → 7.0.0</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/73424e3999f865eac72e27f09d5fe11b9703cfd6"><code>73424e3</code></a> Cleanup the docs a bit.</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/36f1cc2967831dbd4c8aa70086fc86dc495f8b9a"><code>36f1cc2</code></a> Bump pins in template.</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/f299c590a63a48e51e3ae949993dc7bb1f1d480d"><code>f299c59</code></a> Bump the github-actions group with 2 updates</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/25f0b2e0cdbc345c0d3e49170f7a328c3e0d805f"><code>25f0b2e</code></a> Update docs/config.rst</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/bb23eacc5531fb8f499213d8420407e0d72f88e3"><code>bb23eac</code></a> Improve configuration docs</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/a19531e91e1ab753ccf648a2d9bab08a6fddebb9"><code>a19531e</code></a> Switch from build/pre-commit to uv/prek - this should make this faster.</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/82f999391073f2fb8ae422af452602f310086a2a"><code>82f9993</code></a> Update changelog.</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/211b5cd41c29916bc643b4a11b00578ba4fd6fe8"><code>211b5cd</code></a> Fix links.</li> <li><a href="https://github.com/pytest-dev/pytest-cov/commit/97aadd74bcbc00a2078d240e8fe871dd62b83d80"><code>97aadd7</code></a> Update some ci config, reformat and apply some lint fixes.</li> <li>Additional commits viewable in <a href="https://github.com/pytest-dev/pytest-cov/compare/v6.2.1...v7.0.0">compare view</a></li> </ul> </details> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=pytest-cov&package-manager=pip&previous-version=6.2.1&new-version=7.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

elliotgunton added 2 commits July 18, 2023 08:27

Missing minus. print list to stdout to copy easily

bc63bf6

Signed-off-by: Elliot Gunton <[email protected]>

Print md table to copy out

6ed0c02

Signed-off-by: Elliot Gunton <[email protected]>

elliotgunton requested review from flaviuvadan and sambhav as code owners July 18, 2023 08:36

elliotgunton added the type:skip-changelog A change that does not require a changelog entry label Jul 18, 2023

elliotgunton force-pushed the fix-missing-examples-test branch from 30ed27e to b648c53 Compare July 18, 2023 08:45

elliotgunton changed the title ~~Fix missing examples test, add markdown table output~~ Add markdown table output of missing examples to docs Jul 18, 2023

elliotgunton force-pushed the fix-missing-examples-test branch 2 times, most recently from 7ba73a5 to 4cfb1ac Compare July 18, 2023 09:23

Add contribution note to docs

b31b5dc

Signed-off-by: Elliot Gunton <[email protected]>

elliotgunton force-pushed the fix-missing-examples-test branch from 4cfb1ac to b31b5dc Compare July 18, 2023 09:24

Make links clickable in the doc pages

771491a

Signed-off-by: Elliot Gunton <[email protected]>

dejamiko reviewed Jul 18, 2023

View reviewed changes

tests/test_remaining_examples.py Outdated Show resolved Hide resolved

flaviuvadan reviewed Jul 18, 2023

View reviewed changes

flaviuvadan approved these changes Jul 18, 2023

View reviewed changes

elliotgunton added semver:patch A change requiring a patch version bump type:documentation A documentation update and removed type:skip-changelog A change that does not require a changelog entry labels Jul 18, 2023

Sort missing examples, generate table in regenerate-test-data

4b2617a

Signed-off-by: Elliot Gunton <[email protected]>

elliotgunton force-pushed the fix-missing-examples-test branch from aea630c to 4b2617a Compare July 18, 2023 14:30

elliotgunton merged commit 5cfc2ba into main Jul 18, 2023

elliotgunton deleted the fix-missing-examples-test branch July 18, 2023 14:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add markdown table output of missing examples to docs #712

Add markdown table output of missing examples to docs #712

Uh oh!

elliotgunton commented Jul 18, 2023 •

edited

Loading

Uh oh!

codecov bot commented Jul 18, 2023 •

edited

Loading

Uh oh!

Uh oh!

flaviuvadan Jul 18, 2023

Uh oh!

elliotgunton Jul 18, 2023

Uh oh!

elliotgunton Jul 18, 2023

Uh oh!

flaviuvadan left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add markdown table output of missing examples to docs #712

Add markdown table output of missing examples to docs #712

Uh oh!

Conversation

elliotgunton commented Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

flaviuvadan Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

elliotgunton Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

elliotgunton Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

flaviuvadan left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

elliotgunton commented Jul 18, 2023 •

edited

Loading

codecov bot commented Jul 18, 2023 •

edited

Loading