Skip to content

Commit cf925db

Browse files
committed
chore: prepare v0.6.3 release
1 parent 5de1307 commit cf925db

8 files changed

Lines changed: 78 additions & 12 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,10 @@ To review the history of changes, see the [Version Log](./VERSION_LOG.md).
4040
To create a new public build of DocForge:
4141

4242
1. Update the version in `package.json` and regenerate the lockfile with `npm version <new-version> --no-git-tag-version`.
43-
2. Review the Markdown documentation (README, manuals, and version log) so the release notes accurately reflect recent changes.
44-
3. Sync the documentation copies under `docs/` (README, manuals, version log) with any updates made at the project root.
45-
4. Run `npm run publish` to build the application and publish the artifacts to the configured GitHub release target via Electron Builder.
43+
2. Draft the release notes by updating `VERSION_LOG.md` with a new section that summarizes the changes included in the release.
44+
3. Review the Markdown documentation (README, manuals, and release notes) so the written guidance matches the current workflow.
45+
4. Sync the documentation copies under `docs/` (README, manuals, version log) with any updates made at the project root.
46+
5. Run `npm run publish` to build the application and publish the artifacts to the configured GitHub release target via Electron Builder.
4647

4748
## Application Icon Workflow
4849

TECHNICAL_MANUAL.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,10 @@ Electron Builder manages the packaging and publishing workflow for DocForge. The
124124
### Publishing a Release
125125

126126
1. Run `npm version <new-version> --no-git-tag-version` to bump the version in both `package.json` and `package-lock.json` without creating a Git tag.
127-
2. Review and update the Markdown documentation (README, manuals, version logs) so the release notes accurately describe the changes.
128-
3. Execute `npm run publish` to package the application and upload the release artifacts to GitHub.
127+
2. Update `VERSION_LOG.md` with a new section that captures the highlights of the release.
128+
3. Review and update the Markdown documentation (README, manuals, release notes) so the written guidance reflects the final state of the build.
129+
4. Sync the Markdown files under `docs/` with the copies at the project root.
130+
5. Execute `npm run publish` to package the application and upload the release artifacts to GitHub.
129131

130132
### Application Icon Pipeline
131133

VERSION_LOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Version Log
22

3+
## v0.6.3 - The Release Readiness Refresh
4+
5+
This maintenance release aligns the publishing workflow documentation with the
6+
latest release checklist so preparing builds remains predictable and
7+
well-documented.
8+
9+
### 🛠 Improvements
10+
11+
- Clarified the release preparation steps in the README and technical manual
12+
to include drafting release notes and syncing the published documentation
13+
bundle.
14+
- Ensured the `docs/` copies of the manuals stay in lockstep with the root
15+
documentation to avoid drift between the repository and published guides.
16+
17+
### 🐛 Fixes
18+
19+
- Restored the missing release workflow section in the published technical
20+
manual so hosted documentation once again includes the full checklist.
21+
322
## v0.6.2 - The Documentation Polish Update
423

524
This maintenance release focuses on keeping the documentation set in sync with the

docs/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,10 @@ To review the history of changes, see the [Version Log](./VERSION_LOG.md).
4040
To create a new public build of DocForge:
4141

4242
1. Update the version in `package.json` and regenerate the lockfile with `npm version <new-version> --no-git-tag-version`.
43-
2. Review the Markdown documentation (README, manuals, and version log) so the release notes accurately reflect recent changes.
44-
3. Sync the documentation copies under `docs/` (README, manuals, version log) with any updates made at the project root.
45-
4. Run `npm run publish` to build the application and publish the artifacts to the configured GitHub release target via Electron Builder.
43+
2. Draft the release notes by updating `VERSION_LOG.md` with a new section that summarizes the changes included in the release.
44+
3. Review the Markdown documentation (README, manuals, and release notes) so the written guidance matches the current workflow.
45+
4. Sync the documentation copies under `docs/` (README, manuals, version log) with any updates made at the project root.
46+
5. Run `npm run publish` to build the application and publish the artifacts to the configured GitHub release target via Electron Builder.
4647

4748
## Application Icon Workflow
4849

docs/TECHNICAL_MANUAL.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,28 @@ This module handles all communication with the external Large Language Model. It
109109
- **`Sidebar.tsx`:** Manages the display of the `nodes` tree (documents and folders) and templates. It handles search/filtering, drag-and-drop, and keyboard navigation.
110110
- **`DocumentEditor.tsx`:** The primary user-facing editor component. It serves as a layout controller, managing the view mode (editor, preview, split-screen) and containing both the `CodeEditor` (Monaco) and `PreviewPane` components. It orchestrates the flow of data between the editor and the preview.
111111
- **`SettingsView.tsx`:** Manages all application settings, which are now read from and saved to the `settings` table in the database.
112-
- **`DocumentHistoryView.tsx`:** This view now fetches version history for a document directly from the database, providing a reliable timeline of changes.
112+
- **`DocumentHistoryView.tsx`:** This view now fetches version history for a document directly from the database, providing a reliable timeline of changes.
113+
114+
---
115+
116+
## 5. Build & Release Workflow
117+
118+
Electron Builder manages the packaging and publishing workflow for DocForge. The most relevant npm scripts are:
119+
120+
- `npm run build` — Bundles the renderer and preload scripts, prepares assets in `dist/`, and generates platform icon binaries from the source SVG.
121+
- `npm run package` — Produces distributable builds without uploading them.
122+
- `npm run publish` — Builds the application and publishes artifacts using Electron Builder's configured GitHub target.
123+
124+
### Publishing a Release
125+
126+
1. Run `npm version <new-version> --no-git-tag-version` to bump the version in both `package.json` and `package-lock.json` without creating a Git tag.
127+
2. Update `VERSION_LOG.md` with a new section that captures the highlights of the release.
128+
3. Review and update the Markdown documentation (README, manuals, release notes) so the written guidance reflects the final state of the build.
129+
4. Sync the Markdown files under `docs/` with the copies at the project root.
130+
5. Execute `npm run publish` to package the application and upload the release artifacts to GitHub.
131+
132+
### Application Icon Pipeline
133+
134+
- The canonical icon artwork lives at `assets/icon.svg`. During `npm run build` (and thus during `npm run package`/`npm run publish`), the `scripts/prepare-icons.mjs` script validates the SVG and, if valid, generates the required `icon.icns`, `icon.ico`, and `icon.png` files in the `assets/` directory using `icon-gen`.
135+
- If the SVG is missing or invalid, the script logs a warning and leaves the existing binary icon assets untouched so packaging can proceed with the previous icons.
136+
- To regenerate icons without running a full build, execute `npm run prepare:icons`.

docs/VERSION_LOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Version Log
22

3+
## v0.6.3 - The Release Readiness Refresh
4+
5+
This maintenance release aligns the publishing workflow documentation with the
6+
latest release checklist so preparing builds remains predictable and
7+
well-documented.
8+
9+
### 🛠 Improvements
10+
11+
- Clarified the release preparation steps in the README and technical manual
12+
to include drafting release notes and syncing the published documentation
13+
bundle.
14+
- Ensured the `docs/` copies of the manuals stay in lockstep with the root
15+
documentation to avoid drift between the repository and published guides.
16+
17+
### 🐛 Fixes
18+
19+
- Restored the missing release workflow section in the published technical
20+
manual so hosted documentation once again includes the full checklist.
21+
322
## v0.6.2 - The Documentation Polish Update
423

524
This maintenance release focuses on keeping the documentation set in sync with the

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docforge",
3-
"version": "0.6.2",
3+
"version": "0.6.3",
44
"description": "An application to manage and refine documents.",
55
"main": "dist/main.js",
66
"scripts": {

0 commit comments

Comments
 (0)