Skip to content

Commit 1d2440f

Browse files
authored
Merge pull request #58 from beNative/codex/prepare-for-github-release-including-version-update
chore: prepare 0.6.2 release
2 parents 1e7d55a + f680313 commit 1d2440f

6 files changed

Lines changed: 59 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@ DocForge is a desktop application designed to streamline the process of creating
3333
4. **Create:** Start creating, organizing, and refining your documents!
3434

3535
For detailed instructions on usage and features, please refer to the [Functional Manual](./FUNCTIONAL_MANUAL.md).
36+
To review the history of changes, see the [Version Log](./VERSION_LOG.md).
3637

3738
## Release Preparation
3839

3940
To create a new public build of DocForge:
4041

4142
1. Update the version in `package.json` and regenerate the lockfile with `npm version <new-version> --no-git-tag-version`.
4243
2. Review the Markdown documentation (README, manuals, and version log) so the release notes accurately reflect recent changes.
43-
3. Run `npm run publish` to build the application and publish the artifacts to the configured GitHub release target via Electron Builder.
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.
4446

4547
## Application Icon Workflow
4648

VERSION_LOG.md

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

3+
## v0.6.2 - The Documentation Polish Update
4+
5+
This maintenance release focuses on keeping the documentation set in sync with the
6+
project's release workflow so the publishing checklist is easy to follow.
7+
8+
### 🛠 Improvements
9+
10+
- Synced the release preparation guidance between the project README and the
11+
documentation bundle to avoid diverging instructions.
12+
- Linked the README to the version history so maintainers can quickly review
13+
prior changes when drafting release notes.
14+
15+
### 🐛 Fixes
16+
17+
- Corrected outdated documentation references that omitted the release
18+
preparation steps from the published docs bundle.
19+
320
## v0.6.1 - The Release Prep Update
421

522
This maintenance release focuses on preparing DocForge for distribution by polishing the release workflow and tidying up the documentation set.

docs/README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,22 @@ DocForge is a desktop application designed to streamline the process of creating
3232
3. **Configure:** Launch DocForge, open the Settings view, and select your detected LLM service and a model to use for refinement tasks.
3333
4. **Create:** Start creating, organizing, and refining your documents!
3434

35-
For detailed instructions on usage and features, please refer to the [Functional Manual](./FUNCTIONAL_MANUAL.md).
35+
For detailed instructions on usage and features, please refer to the [Functional Manual](./FUNCTIONAL_MANUAL.md).
36+
To review the history of changes, see the [Version Log](./VERSION_LOG.md).
37+
38+
## Release Preparation
39+
40+
To create a new public build of DocForge:
41+
42+
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.
46+
47+
## Application Icon Workflow
48+
49+
- The canonical artwork lives at `assets/icon.svg`. Keep this SVG under version control to simplify brand updates.
50+
- `npm run build` (and any script that calls it) automatically validates the SVG and regenerates `icon.icns`, `icon.ico`, and a high-resolution `icon.png` via the `scripts/prepare-icons.mjs` helper.
51+
- If the SVG is missing or invalid the script logs a warning and leaves existing binary icons untouched, allowing packaging to proceed with the previously generated assets.
52+
- Run `npm run prepare:icons` to regenerate the platform-specific icons on demand without rebuilding the JavaScript bundles.
53+

docs/VERSION_LOG.md

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

3+
## v0.6.2 - The Documentation Polish Update
4+
5+
This maintenance release focuses on keeping the documentation set in sync with the
6+
project's release workflow so the publishing checklist is easy to follow.
7+
8+
### 🛠 Improvements
9+
10+
- Synced the release preparation guidance between the project README and the
11+
documentation bundle to avoid diverging instructions.
12+
- Linked the README to the version history so maintainers can quickly review
13+
prior changes when drafting release notes.
14+
15+
### 🐛 Fixes
16+
17+
- Corrected outdated documentation references that omitted the release
18+
preparation steps from the published docs bundle.
19+
320
## v0.6.1 - The Release Prep Update
421

522
This maintenance release focuses on preparing DocForge for distribution by polishing the release workflow and tidying up the documentation set.

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.1",
3+
"version": "0.6.2",
44
"description": "An application to manage and refine documents.",
55
"main": "dist/main.js",
66
"scripts": {

0 commit comments

Comments
 (0)