Skip to content

Check version directives #2026

Closed
Closed

Description

@niccokunzmann

We have version...added ...changed and ... removed in the docs.

It would be good to test this in CI:

For all the mentioned versions, there is a tag.
Git pull tags shallow in case it is needed.
The version 0.0.0 is also ok. It will be renamed anyway for a release and is the one all new changes should use.

Problem: this should not fail on main just before a release tag is created, so maybe the tests just make sure that a new version directive has 0.0.0 in it or the test is skipped if on a release branch (main or (version).x)
It should also not fail if git is not present.

It looks quite simple but has a lot of constraints. What we want to avoid is a version directive in a PR that is added but fixes the version to something unreleased. The PR does not know about the future release.

A simple solution is preferred, not lots of code. It might not be feasable to test that.

Activity

  1. github-actions commented on Oct 25, 2026

    @github-actions
    Contributor

    Thanks for the issue, @niccokunzmann! A maintainer will review it shortly.

  2. changed the title [-]Ceck version directives[/-] [+]Check version directives[/+] on Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions