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

docs: Add example and fix typo for readme of regex versioning module #33333

Merged
merged 1 commit into from
Dec 30, 2024

Conversation

kennethso168
Copy link
Contributor

Changes

This adds an example for linuxserver/tautulli docker image to show that for the fourth version part (the ls number), the build capture group should be used. This differs from the current example of linuxserver/openssh-server which the ls number is the fifth version part so versioning should be used. Closes #33270.

Also fixes typo in the doc (should be matchPackageNames instead of matchPackageNamees)

Context

I have opened an discussion #33270 while attempting to adapting the linuxserver/openssh-server example for linuxserver/librespeed. Afterwards the maintainer replied that the build instead of versioning capture group should be used for the fourth versioning part (the ls number).

I think most linuxserver.io image tags follow semver plus build number (x.y.z-lsnn). ghcr.io/linuxserver/openssh-server is a particularly difficult case with the five capture groups. I think it is a good idea to add an additional example to show how to handle linuxserver.io image tags in the format of x.y.z-lsnn. I believe that this will let beginners to get started to use renovate with most linuxserver.io images. This will also clearly demonstrate that when only four version parts are needed, build instead of revision should be used for the fourth capture group.

I choose tautulli as an example as this is the fourth most pulled linuxserver image according to their stats. The version tag prefixed with v also further demonstrates a difference with openssh-server.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

This adds an example for linuxserver/tautulli docker image to show that for the fourth version part (the ls number), build should be used. This differs from the current example of linuxserver/openssh-server which the ls number is the fifth version part so versioning should be used. Closes discussion renovatebot#33270. Also fixes typo in the doc.
@kennethso168 kennethso168 changed the title Add example and fix typo for readme of regex versioning module docs: Add example and fix typo for readme of regex versioning module Dec 30, 2024
@rarkins rarkins enabled auto-merge December 30, 2024 11:16
@rarkins rarkins added this pull request to the merge queue Dec 30, 2024
Merged via the queue into renovatebot:main with commit a0b259b Dec 30, 2024
39 checks passed
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.

2 participants