Skip to content

Commit 8893a2f

Browse files
authored
Merge pull request #36 from beNative/codex/prepare-for-github-release
chore: prepare 0.24.6 release
2 parents 2bf7ab2 + 4c2c4ff commit 8893a2f

4 files changed

Lines changed: 14 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ All notable changes to this project will be documented in this file.
66

77
- _No unreleased changes._
88

9+
## [0.24.6]
10+
11+
### Changed
12+
- **Documentation Checklist Clarity:** Clarified the release preparation steps in `README.md` and `TECHNICAL_MANUAL.md` so
13+
maintainers explicitly record the outcome of their documentation review (even when no edits are required) before publishing a
14+
release.
15+
16+
### Fixed
17+
- **Version Metadata:** Incremented the application version to `0.24.6` in `package.json` ahead of publishing this patch build.
18+
919
## [0.24.5]
1020

1121
### Changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ Follow this checklist when preparing a new minor or patch release:
5959
1. **Bump the Version:** Update the `version` field in `package.json` and ensure any user-facing references (README, manuals,
6060
in-app messaging) match the new number.
6161
2. **Review Documentation:** Re-read the README, Functional Manual, Technical Manual, and CHANGELOG to confirm terminology and
62-
screenshots reflect the current UI and workflow. Capture any documentation-only tweaks in the upcoming changelog entry so the
63-
review is recorded.
62+
screenshots reflect the current UI and workflow. Capture any documentation-only tweaks in the upcoming changelog entry, and
63+
if everything is still accurate, explicitly state that outcome so the review itself is recorded.
6464
3. **Update Release Notes:** Add a new section to `CHANGELOG.md` summarizing the changes included in the release, including
6565
any documentation adjustments or reminders for maintainers. Plan to reuse this text verbatim in the GitHub release body.
6666
4. **Run Automated Checks:** Execute `npm test` (or the appropriate suite documented in the Technical Manual) and confirm it completes successfully before packaging.

TECHNICAL_MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ All application data, including repositories, categories, and global settings, i
9090
Use this process when shipping a new minor update or bugfix:
9191

9292
1. **Increment the Version:** Update the `version` in `package.json` and verify the README, manuals, and any in-app references reflect the new number where applicable.
93-
2. **Refresh Documentation:** Re-read `README.md`, `FUNCTIONAL_MANUAL.md`, `TECHNICAL_MANUAL.md`, and `CHANGELOG.md` to ensure screenshots, feature descriptions, and workflows match the current UI. Note any documentation-only edits in the changelog so the audit trail is preserved.
93+
2. **Refresh Documentation:** Re-read `README.md`, `FUNCTIONAL_MANUAL.md`, `TECHNICAL_MANUAL.md`, and `CHANGELOG.md` to ensure screenshots, feature descriptions, and workflows match the current UI. Note any documentation-only edits in the changelog, and if no changes are required, explicitly record that the review confirmed the docs remain accurate so the audit trail is preserved.
9494
3. **Update Release Notes:** Add a new entry to `CHANGELOG.md` summarizing the changes, calling out documentation adjustments alongside any fixes or features. Plan to reuse this text verbatim in the GitHub release body.
9595
4. **Run Automated Checks:** Execute `npm test` (or the broader QA suite defined for the project) and confirm a passing result before packaging binaries.
9696
5. **Build Installers:** Run `npm run pack`. The command produces platform installers in the `release/` directory. Perform a quick smoke test of the generated artifacts before distribution.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "git-automation-dashboard",
3-
"version": "0.24.5",
3+
"version": "0.24.6",
44
"description": "A dashboard to manage and automate the workflow for a set of Git repositories.",
55
"main": "dist/main.js",
66
"author": "AI Assistant",

0 commit comments

Comments
 (0)