docs: add CHANGELOG.md and document release process (#227) - #341
Merged
blockchain-maxis merged 3 commits intoSep 2, 2026
Merged
Conversation
|
@Lazyartist1 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
@Ipramking is attempting to deploy a commit to the blockchainmaxis-8449's projects Team on Vercel. A member of the Team first needs to authorize it. |
✅ Deploy Preview for stellar-signet ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lazyartist1
force-pushed
the
docs/changelog-release-process-227
branch
from
August 30, 2026 16:10
bc878e8 to
477dbab
Compare
…ding Two things in CHANGELOG.md would have become wrong public references, which is the exact risk issue blockchain-maxis#227 opens with. The testnet identity-registry address was CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIXF47ZG2FB2RMQQVU2HHGCYSC, which appears nowhere else in the repo. The deployed registry — used by playwright.config.ts and e2e/testnet-claim.spec.ts — is CASFJHI5PQSRWS7JV25CF7FOMRKIVBP3RXRP3E2GH2CV4BCAG7FUJRCN. Both are live contracts on testnet, so a valid-looking address is not enough to tell them apart. Simulating the registry's own count() separates them: CASFJ… → count() = 2 CDLZF… → HostError: Error(Value, InvalidInput) so CDLZF… is some other contract that does not implement this interface. Dropped the invented 2026-07-09 deployment date with it. Also, [0.1.0] - 2026-08-28 claims a release that never happened: there are no git tags, and packages/sdk is at 0.0.0, while the RELEASING.md added in this same PR makes an annotated tag the marker of a release. Retitled to 'not yet tagged' with a note to date it when v0.1.0 is really cut. Prettier over the two new files; README's drift is pre-existing on main and left alone. node scripts/check-docs.mjs passes.
blockchain-maxis
merged commit Sep 2, 2026
6763303
into
blockchain-maxis:main
10 of 11 checks passed
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
2 participants
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.
Closes #227
Summary of Changes
Adds
CHANGELOG.mdfollowing the Keep a Changelog standard and documents the release procedure, SemVer policy, and tagging conventions indocs/RELEASING.md.Key Additions
Changelog (
CHANGELOG.md):Release Documentation (
docs/RELEASING.md):@signet/sdk, contracts (identity-registry),@signet/web, and@signet/indexer.vX.Y.Z), SDK package releases (sdk-vX.Y.Z), and contract wasm releases (contract-vX.Y.Z).Repository Navigation (
README.md):CHANGELOG.mdanddocs/RELEASING.mdin the README navigation.Verification Status
node scripts/check-docs.mjspassed cleanly (24 markdown files, 27 env vars, no drift).node scripts/check-contract-errors.mjspassed (9 variants matched).