SSWConsulting / SSWConsulting/TimePro.Tools

Versioning: local builds as 0.0.0 and allow x.y.0 as the first release of a prefix

Open
#56 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Priority: P2 Type: DevOps
Dominant language
C#
Stars
3
Forks
0
Avg merge
29m
Merged PRs (30d)
28

Description

Today local builds are <VersionPrefix>.0 (0.3.0) and the release workflow computes the next patch from existing tags, so the first release on a new prefix is x.y.1 and release-notes/AGENTS.md reserves patch-zero for developer builds. That made this release 0.3.1 when 0.3.0 was intended.

Proposal:

  • Local builds use 0.0.0-local (or 0.0.0) so a dev build can never be confused with a published one and tp --version makes it obvious.
  • The workflow starts at .0 when no tag exists for the prefix, and .N+1 otherwise.
  • release-notes/AGENTS.md, docs/Instructions-Deployment.md and the csproj comment updated to match, and ReleaseNotesCatalogTests checked for assumptions.

Do this before the 0.4 release so it can be 0.4.0.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the release workflow and the csproj versioning comment, then read release-notes/AGENTS.md and docs/Instructions-Deployment.md. Run ReleaseNotesCatalogTests to identify existing assumptions. Done means local builds use the proposed version, a new prefix releases as x.y.0, later releases increment the patch, and the documentation and comments match.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system, cli, documentation, release, testing-qa
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.