Skip to content

docs: list implemented GA4GH spec versions - #144

Open
uniqueg wants to merge 2 commits into
mainfrom
docs/143-spec-versions
Open

uniqueg wants to merge 2 commits into
mainfrom
docs/143-spec-versions

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 13, 2026 •

Copy link
Copy Markdown
Member

Summary

Replaces the per-API table on the GA4GH Standards page with one row per product (proTES, TESK, Funnel, proWES, CWL-WES, DRS-Filer, TRS-Filer, Cloud Registry): the implemented version of its GA4GH specification and the current upstream version, each linked to its source (the spec file on the product's default branch, or the spec commit for submodules; the upstream release page).

Facts read from the default branches, not from earlier notes:

  • proTES: TES 1.1.0 (spec commit 117cd92 is identical to tag v1.1); the old page said 1.0.
  • TESK: TES 1.0.0 (tesk-api's tes submodule at cafac9c, 60 commits behind v1.1).
  • Funnel (calypr/funnel develop): submodule 28a83a6, 144 commits after v1.1; no release stated, noted as such.
  • Poiesis (added after the Sourcery review; JaeAeich/poiesis dev): spec c4c17c9, 132 commits after v1.1; no release stated.
  • proWES: WES 1.0.1; CWL-WES: WES 1.0.0; upstream 1.1.0.
  • DRS-Filer: DRS 1.1.0; upstream 1.5.0.
  • TRS-Filer: TRS 2.0.2 (spec commit 4854e2f is identical to tag 2.0.2, though its info.version says 2.1.0, which is unreleased).
  • Cloud Registry: Service Registry 1.0.0 (current).

Light lane: docs-only change; I reviewed the diff myself, no reviewer subagents.

Closes #143

Verification

  • python scripts/check_names.py: passed
  • mkdocs build --strict: passed, no warnings
  • CI: all checks passed (CI passed, Docs, Test, PR title, CodeQL, Read the Docs)

Open questions

None.

🤖 Generated with Claude Code

One row per product with the implemented and the current version of
its GA4GH specification, each linked to its source: the spec file on
the product's default branch and the upstream release page. Read from
the repos: proTES implements TES 1.1.0 (not 1.0), TRS-Filer TRS 2.0.2,
Funnel a TES commit after 1.1.0 without a stated release.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Documentation

Replace the API-focused overview with a product-by-product table of implemented and current GA4GH specification versions, linking each version to its source.

  • docs/partners-and-developers/ga4gh-standards.md L11-27

Add notes explaining version discrepancies, submodule-based specifications, and products without a stated release, while retaining guidance to check product documentation for deviations.

  • docs/partners-and-developers/ga4gh-standards.md L28-43

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

@uniqueg
uniqueg marked this pull request as ready for review November 13, 2026 22:51
@read-the-docs-community

read-the-docs-community Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 elixir-on-cloud-docs | 🛠️ Build #35881062 | 📁 Comparing d33ddc3 against latest (c0e5d36)

  🔍 Preview build  

1 file changed
± partners-and-developers/ga4gh-standards/index.html

@sourcery-ai

sourcery-ai Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Linked issues

Checked at commit d33ddc3

#143 docs: show implemented GA4GH spec versions · 3 of 3 met

# Requirement Status Notes
1 List the implemented and current specification versions for proTES, TESK, Funnel, proWES, CWL-WES, DRS-Filer, TRS-Filer, and Cloud Registry, with source links. ✅ Met The table includes all eight products and links the implemented specification and upstream release sources.
2 Mark unknown versions explicitly. ✅ Met Funnel's implemented release is marked “not stated,” with a link to its pinned specification commit.
3 Pass the strict docs build. ✅ Met The PR description reports that mkdocs build --strict passed.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 2 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/partners-and-developers/ga4gh-standards.md" line_range="21" />
<code_context>
+| [Funnel][funnel] | [TES][ga4gh-tes], for tasks | 1.1.0 and later changes: not stated as a release; [its submodule](https://github.com/calypr/funnel/tree/develop/api/tes) points to a commit after 1.1.0 | [1.1.0](https://github.com/ga4gh/task-execution-schemas/releases/tag/v1.1) | [Funnel][funnel] |
</code_context>
<issue_to_address>
**Funnel snapshot cannot be reproduced**

When a reader needs to verify the post-1.1.0 snapshot or Funnel’s develop branch advances, the link to `develop/api/tes` follows a mutable branch, so it no longer identifies the submodule commit used and readers cannot verify the specification snapshot described.

Link to the specific submodule commit instead of the mutable `develop` path.
</issue_to_address>

### Comment 2
<location path="docs/partners-and-developers/ga4gh-standards.md" line_range="17" />
<code_context>
+that the product's default branch builds on, and the release page of the
+specification. Checked in November 2026.
+
+| Product | API | Implemented version | Current version | Docs |
+| --- | --- | --- | --- | --- |
+| [proTES](https://github.com/elixir-cloud-aai/proTES) | [TES][ga4gh-tes], for tasks | [1.1.0](https://github.com/elixir-cloud-aai/proTES/blob/dev/pro_tes/api/20221114.117cd92.task_execution_service.openapi.yaml) | [1.1.0](https://github.com/ga4gh/task-execution-schemas/releases/tag/v1.1) | [proTES](https://protes.readthedocs.io/en/latest/) |
</code_context>
<issue_to_address>
**Poiesis version is omitted**

When a reader considers Poiesis as a Kubernetes TES option, the product table has no Poiesis row, so readers comparing supported Kubernetes TES services cannot find its implemented specification version.

Add Poiesis with its verified implemented version and source, or explicitly state that its version has not been verified and why it is excluded.
</issue_to_address>

Sourcery assessment

Approval pending. 2 findings to address first.

Blocking findings: docs/partners-and-developers/ga4gh-standards.md:21, docs/partners-and-developers/ga4gh-standards.md:17


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Link Funnel's TES version to the pinned submodule commit instead of
the moving develop branch, and add Poiesis, which the operator docs
list as a TES service (review by Sourcery).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourcery assessment

Approved.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: show implemented GA4GH spec versions

1 participant