Release Process review
Date: May 14, 2025
Reviewer: @Ali González
Version to be reviewed: Version number to be determined
1. Structural changes
Title | Owner | Notes |
|---|---|---|
Version number to be revised | @Ali González | Last live version is 23Q4 while what’s listed on the 1- version history is only version 1. There are release notes in this confluence for versions 1.1.0 https://govstack-global.atlassian.net/wiki/x/AYBfFQ and 1.2.0 https://govstack-global.atlassian.net/wiki/x/D4CpKg Ali will propose a final version number tally |
Add Release notes | @Ali González | What’s currently in 10 is part of Release Notes. Ali to make a first draft and share with @Kibuuka, Arnold |
Review what should actually go in section 10 | @Ali González @Kibuuka, Arnold | Section 10 is for reference materials related to the content of the specification. Ali and Arnold will meet to review what goes there. |
Add use case or reference section 10 (perhaps in patch version) | @Ali González | Low priority but seems Payments WG has compiled very good materials in Annex 4 Deliverables we can go through those documents and see if they fit an additional use case section |
2. Formatting changes
Section 1 - Version History
Change version numbers to semver format (1.0.0 and 1.1.0)
Change latest version 1.1.0 from bold to normal
Add link to release notes page, once created, on comment for version 1.1.0. Ideally we'd have a Release notes page per major version only and denote the changelog referencing each version on an H1 like # 1.1.0
Section 5 - Cross-Cutting Requirements
Remap numeral headings like this:
Major numeral is H1
Minor numeral is H2
Ensure 5.1.16 remains at correct level. It is now H2. After with the remapping would be correct
On 5.4 Standards, Link to official webpage for each standard
Section 6 - Functional Requirements
Sub-numerals 6.2.1 and 6.2.2 require reference to their number
6.7 paragraphs after requirement bullet points need tab correction
6.3 Paragraphs after bullet points need tab correction
6.16 re indent whole requirement
Section 7 - Data structures
Review table style as available here: https://govstack.gitbook.io/bb-wallet/7-data-structures
3. Release Process
Craft release announcement
Are there any CtA regarding this release? invite people to review, implement, contact you?