Skip to content

docs: add note about version number interpretation #272

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Apr 7, 2025
Merged

docs: add note about version number interpretation #272

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b81fce1
docs: add note about version numbering
adarsh4d Apr 7, 2025
fead442
chore: add code highlight
adarsh4d Apr 7, 2025
49288fe
Update README.md
pi0 Apr 7, 2025
d640658
Apply suggestions from code review
pi0 Apr 7, 2025
b5d4033
Update README.md
pi0 Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ npx changelogen@latest [...args] [--dir <dir>]
- `--prerelease`: Bump as a semver-prerelease version, can set id with string.
- `--hideAuthorEmail`: Do not include author email in changelog if github username cannot be found.

> [!NOTE]
> Version numbers starting with `0.` or `0.0.` follow different rules.
>
> In these cases, the second or third digit is treated as the major version. They use the formats `0.major.minor` and `0.0.major` instead of the standard `major.minor.patch`.
>
> To ensure consistent semantic versioning, start version numbering at `1.0.0`.

### `changelogen gh release`

Changelogen has built-in functionality to sync with Github releases.
Expand Down