Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement TodoByVersionRule #12

Merged
merged 8 commits into from
Dec 18, 2023
Merged

Implement TodoByVersionRule #12

merged 8 commits into from
Dec 18, 2023

Conversation

staabm
Copy link
Owner

@staabm staabm commented Dec 18, 2023

Reference version

By default version-todo-comments are checked against "nextMajor" version.
This is determined by fetching the latest local available git tag and incrementing the major version number.

This behaviour can be configured with the referenceVersion option.
Possible values are "nextMajor", "nextMinor", "nextPatch" - which will be computed based on the latest local git tag - or any other version string like "1.2.3".

parameters:
    todo_by:
        # "nextMajor", "nextMinor", "nextPatch" or a version string like "1.2.3"
        referenceVersion: "nextMinor"

Make sure tags are available within your git clone, e.g. by running git fetch --tags origin.

In a GitHub Action this can be done like this:

    -   name: Checkout
        uses: actions/checkout@v4

    -   name: Get tags
        run: git fetch --tags origin

closes #6

@staabm staabm marked this pull request as ready for review December 18, 2023 10:58
@staabm staabm merged commit b045f3c into main Dec 18, 2023
17 checks passed
@staabm staabm deleted the version branch December 18, 2023 10:58
@staabm staabm mentioned this pull request Dec 18, 2023
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.

expire by version
1 participant