diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json index 5cc741ff6..e3c2d4362 100644 --- a/docs/Developer Guide/!!!meta.json +++ b/docs/Developer Guide/!!!meta.json @@ -433,6 +433,40 @@ "format": "markdown", "dataFileName": "Documentation.md", "attachments": [] + }, + { + "isClone": false, + "noteId": "4nwtTJyjNDKd", + "notePath": [ + "jdjRLhLV3TtI", + "a0mkxxB4Uvbf", + "4nwtTJyjNDKd" + ], + "title": "Releasing a new version", + "notePosition": 70, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zdQzavvHDl1k", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-rocket", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Releasing a new version.md", + "attachments": [] } ] }, @@ -2213,40 +2247,6 @@ "attachments": [], "dirFileName": "Old documentation", "children": [ - { - "isClone": false, - "noteId": "rLWcPPQi7Eso", - "notePath": [ - "jdjRLhLV3TtI", - "ibAPHul7Efvr", - "rLWcPPQi7Eso" - ], - "title": "Releasing a version", - "notePosition": 20, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "relation", - "name": "internalLink", - "value": "IxkDdjTogO18", - "isInheritable": false, - "position": 10 - }, - { - "type": "label", - "name": "shareAlias", - "value": "releasing", - "isInheritable": false, - "position": 20 - } - ], - "format": "markdown", - "dataFileName": "Releasing a version.md", - "attachments": [] - }, { "isClone": false, "noteId": "6BWwXzPCph4G", diff --git a/docs/Developer Guide/Developer Guide/Building/Documentation.md b/docs/Developer Guide/Developer Guide/Building/Documentation.md index d7e78f42e..6ce33eeaf 100644 --- a/docs/Developer Guide/Developer Guide/Building/Documentation.md +++ b/docs/Developer Guide/Developer Guide/Building/Documentation.md @@ -1,4 +1,8 @@ # Documentation +## Editing the documentation + +To edit the documentation run `pnpm edit-docs:edit-docs`. This will spin up a custom Trilium desktop instance which automatically imports the documentation into memory. Any changes will update in the background the files which can then be committed. + ## Automation The documentation is built via `apps/build-docs`: diff --git a/docs/Developer Guide/Developer Guide/Building/Releasing a new version.md b/docs/Developer Guide/Developer Guide/Building/Releasing a new version.md new file mode 100644 index 000000000..8e62e8f36 --- /dev/null +++ b/docs/Developer Guide/Developer Guide/Building/Releasing a new version.md @@ -0,0 +1,19 @@ +# Releasing a new version +Releasing is mostly handled by the CI: + +* The version on GitHub is published automatically, including the description with the change log which is taken from the documentation. +* A PR is created automatically on the Winget repository to update to the new version. + +Releases are usually made directly from the `main` branch. + +The process is as follows: + +1. Edit the Documentation to add a corresponding entry in the _Release notes_ section. +2. In the root `package.json`, set `version` to the new version to be released. +3. Run `chore:update-version` to automatically update the version of the rest of the `package.json` files. +4. Run `pnpm i` to update the package lock as well. +5. Commit the changes to the `package.json` files and the `package-lock.json`. The commit message is usually `chore(release): prepare for v1.2.3`. +6. Tag the newly created commit: `git tag v1.2.3` +7. Push the commit and the newly created tag: `git push; git push --tags`. +8. Wait for the CI to finish. +9. When the release is automatically created in GitHub, download it to make sure it works OK. \ No newline at end of file diff --git a/docs/Developer Guide/Developer Guide/Old documentation/Releasing a version.md b/docs/Developer Guide/Developer Guide/Old documentation/Releasing a version.md deleted file mode 100644 index ed3706f7e..000000000 --- a/docs/Developer Guide/Developer Guide/Old documentation/Releasing a version.md +++ /dev/null @@ -1,22 +0,0 @@ -# Releasing a version -On NixOS: - -``` -nix-shell -p dpkg fakeroot jq nodejs_20 -``` - -Then simply run from project root: - -``` -./bin/release.sh 1.2.3 -``` - -where `1.2.3` is the desired release version. - -If a version ends with `-beta`, it will automatically be marked as pre-release in GitHub. - -This will automatically generate a release in GitHub if everything goes according to plan. - -Note that the Windows installer is not automatically uploaded yet, it has to be taken from the [main workflow of the CI from the `develop` branch](../Architecture/CI/Main.md). - -Make sure to check test the artifacts of the release. \ No newline at end of file