No leading zero on versions

[edwardtfn]

Summary by CodeRabbit

• Documentation

  • Updated versioning examples and rules to a new format: year.month.sequential_number.
  • Introduced a "Version Validation" section outlining strict validation rules for versioning.

• Chores

  • Improved the versioning script for better functionality and error handling, including enhanced version format validation and simplified sequence number management.

[coderabbitai]

Walkthrough

The pull request modifies the versioning documentation and the bump_version.sh script to implement a new versioning scheme. The changes introduce a more flexible version format of year.month.sequential_number, with specific validation rules. The script now handles month and sequence number extraction more dynamically, removing leading zeros and simplifying version increment logic. These modifications aim to standardize and improve the project's versioning approach.

Changes

File	Change Summary
versioning/README.md	- Updated versioning format from YYYY.MM.NN to year.month.sequential_number - Added new "Version Validation" section with strict validation rules - Removed previous versioning rules section
versioning/bump_version.sh	- Added quotes to $VERSION_FILE variable - Updated month extraction to use date +%-m - Modified version format regex for more flexible validation - Simplified sequence number handling - Updated new version string construction

Possibly related PRs

• New versioning #39: Directly related to the versioning process modifications, involving similar updates to version format and validation mechanisms.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1f1a804 and e634479.

📒 Files selected for processing (1)

• versioning/README.md (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• versioning/README.md

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0dddc07 and 1f1a804.

📒 Files selected for processing (2)

• versioning/README.md (1 hunks)
• versioning/bump_version.sh (2 hunks)

🧰 Additional context used

🪛 LanguageTool

versioning/README.md

[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...t as plain text. - bump_version.sh: A script to increment the version based...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~15-~15: Loose punctuation mark.
Context: ... and release sequence. - README.md: Documentation for the versioning proces...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (3)

versioning/bump_version.sh (2)

27-27: LGTM! Sequence number handling simplified correctly.

The changes properly implement:

• Direct sequence number increment without leading zeros
• Clean reset to 1 for new months

Also applies to: 29-29

---

32-32: LGTM! Version string construction is correct.

The new version string construction properly implements the format year.month.sequential_number without leading zeros.

versioning/README.md (1)

8-10: LGTM! Version examples accurately reflect the new format.

The examples clearly demonstrate the new versioning scheme without leading zeros.