docs: Update for semantic versioning [doc-updater] - #499
Closed
james-in-a-box[bot] wants to merge 1 commit into
Closed
docs: Update for semantic versioning [doc-updater]#499james-in-a-box[bot] wants to merge 1 commit into
james-in-a-box[bot] wants to merge 1 commit into
Conversation
Update documentation to reflect changes from e2ae502: - Add create-release.sh to STRUCTURE.md workflow scripts section - Expand deployment.md to document semantic version tags (v0, v0.1, v0.1.0) - Add RELEASING.md to index.md development section The commit introduced a comprehensive semantic versioning system with a release script and floating tag support. These docs ensure the new release process and version pinning options are discoverable. Authored-by: egg
Contributor
Author
There was a problem hiding this comment.
Review Summary
This is a documentation-only PR that updates three files to reflect changes from the semantic versioning commit (e2ae502). I've reviewed all changes systematically.
Files Reviewed
docs/development/STRUCTURE.md ✓
- Adds
create-release.shto the GitHub Workflows Scripts section - Entry is correctly positioned alphabetically (after
checks/, beforepush-contract-update.sh) - File exists and is executable at
.github/scripts/create-release.sh - Description accurately reflects the script's purpose
docs/guides/deployment.md ✓
- Removes
:latestfrom image table (appropriate since tags are now documented separately) - Adds comprehensive Version Tags section explaining the tag hierarchy
- Examples are clear and accurate (
v0,v0.1,v0.1.0,latest) - Pre-release behavior is correctly documented (exact tag only, no floating tags)
- Enhanced
.envexamples with comments and major version pinning option - Link to RELEASING.md uses correct relative path (
../../RELEASING.mdresolves correctly fromdocs/guides/)
docs/index.md ✓
- Adds RELEASING.md to the Development section
- Placement is appropriate (after Contributing.md, as releasing logically follows development workflow)
- Link uses correct relative path (
../RELEASING.mdresolves correctly fromdocs/)
Verification Performed
- Confirmed
create-release.shexists at the documented location - Confirmed the referenced commit (e2ae502) exists with expected message
- Verified all relative links resolve to valid files
- Confirmed documentation is consistent with RELEASING.md content
No issues found. Documentation changes accurately reflect the semantic versioning infrastructure.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
Contributor
Author
| egg is addressing review feedback... |
Contributor
Author
|
egg feedback addressed. View run logs 1 previous review(s) hidden. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update documentation to reflect changes from e2ae502 (Re-land semantic versioning with review fixes #487).
Changes
docs/development/STRUCTURE.md
create-release.shto the GitHub Workflows Scripts sectiondocs/guides/deployment.md
docs/index.md
Rationale
The semantic versioning commit introduced:
.github/scripts/create-release.shscript for creating releasesThese documentation updates ensure the new infrastructure is discoverable through the project structure docs, deployment guides reference the version tagging scheme, and the release documentation is linked from the index.
Triggered by: e2ae502
Authored-by: egg