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

Add version pattern to the documentation #1722

Closed
wants to merge 1 commit into from
Closed

Add version pattern to the documentation #1722

wants to merge 1 commit into from

Conversation

MunishMummadi
Copy link

@MunishMummadi MunishMummadi commented Mar 6, 2024

Description

This pull request adds the version pattern to the documentation. The version pattern is used to extract and match version numbers from project releases. It helps users understand how versioning is structured and how to interpret project version numbers.

Changes Made

  • Added the version pattern to the documentation.
  • Included the regular expression v?(\d+\.\d+\.\d+) to match version numbers like 0.12.1, 1.0.0, etc., following the calendar versioning format.

Purpose

  • Provide clarity on the versioning scheme used in the project, specifically calendar versioning (CalVer).
  • Help users easily understand and work with version numbers when interacting with the project.

Additional Notes

This version pattern is designed for projects following the calendar versioning scheme (CalVer). If there are any changes or updates needed to the pattern, please let me know.

This PR closes issue #1604

@MunishMummadi MunishMummadi requested a review from a team as a code owner March 6, 2024 05:41
Copy link

Build succeeded.
https://fedora.softwarefactory-project.io/zuul/buildset/f21d69a0aa0a422ea39afb5fc7f7facb

✔️ fi-tox-mypy SUCCESS in 5m 56s
✔️ fi-tox-lint SUCCESS in 5m 20s
✔️ fi-tox-format SUCCESS in 5m 17s
✔️ fi-tox-python38 SUCCESS in 11m 09s
✔️ fi-tox-python39 SUCCESS in 10m 14s
✔️ fi-tox-python310 SUCCESS in 9m 16s
✔️ fi-tox-python311 SUCCESS in 9m 35s
✔️ fi-tox-docs SUCCESS in 8m 31s
✔️ fi-tox-bandit SUCCESS in 5m 31s
✔️ fi-tox-diff-cover SUCCESS in 11m 33s

@Zlopez
Copy link
Contributor

Zlopez commented Mar 6, 2024

@MunishMummadi Thanks for the contribution, but the description is wrong. This version pattern is only for calendar versioning, which has completely different format from the standard semantic versioning you are describing in the PR. Could you update the PR to reflect that?

@MunishMummadi
Copy link
Author

hey @Zlopez . I am new to contributing. Sorry about that and sorry for the delay. I am in CST zone. I made changes based on the documentation you provided. Please guide if I have made any mistakes. Thank you.

@Zlopez
Copy link
Contributor

Zlopez commented Mar 6, 2024

No problem with the delay, I don't assume you are sitting here all day. But I don't see the changes in the pull request, maybe you forgot to push them.

@MunishMummadi
Copy link
Author

Hey, You are saying there are issues with my description right. I added few lines stating it is a calendar versioning. That is what i understood. Can you guide me a bit more.

@Zlopez
Copy link
Contributor

Zlopez commented Mar 7, 2024

I meant that what you described in PR is not even calendar versioning, but semantic versioning. And this is not what the version pattern is even used for. Just look at the tooltip for the field on https://release-monitoring.org/ when creating a new project and you will see.

@NyuydineBill
Copy link
Contributor

Hey, You are saying there are issues with my description right. I added few lines stating it is a calendar versioning. That is what i understood. Can you guide me a bit more.

Hi @MunishMummadi I wish to ask some questions regards to how you logged in on local machine
I have messaged you privately

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.

3 participants