build: Automate release process #32
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds GitHub Actions workflow for automated releases, including:
- Build for multiple OSs:
- macOs (Universal `dmg` for both Intel & M1)
- Windows `exe`
- Linux:
- `AppImage`
- `deb`
- `rpm`
- Changelog is automatically generated when a version number tag is added to a commit e.g. `v0.9.2`.
This streamlines the release process and ensures consistent releases across all platforms.
Usage:
1. Update version number in `package.json`.
2. ```
git commit -m "Release v0.9.2"
git tag v0.9.2 # The version number must be in the format `v1.2.3`.
git push --force --tags
```
3. That's it... a release will be automatically generated along with conventional commit messages and installation packages for each platform.
To ensure we pick up all changes we should probably add the conventional commits pre-commit hook to ensure commit messages contain the required `fix`, `feat` etc.
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 15, 2024
In order for the automatic release process VRPirates#32 to work we need to ensure that we always use conventional commits in order for the changelog to be generated correctly. This patch ensures that this is the case
Open
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 15, 2024
In order for the automatic release process VRPirates#32 to work we need to ensure that we always use conventional commits in order for the changelog to be generated correctly. This patch ensures that this is the case fix VRPirates#36
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 15, 2024
In order for the automatic release process VRPirates#32 to work we need to ensure that we always use conventional commits in order for the changelog to be generated correctly. This patch ensures that this is the case.
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 17, 2024
In order for the automatic release process VRPirates#32 to work we need to ensure that we always use conventional commits in order for the changelog to be generated correctly. This patch ensures that this is the case.
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 17, 2024
In order for the automatic release process VRPirates#32 to work we need to ensure that we always use conventional commits in order for the changelog to be generated correctly. This patch ensures that this is the case. build: Add eslint fix: xxx
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 17, 2024
In order for the automatic release process VRPirates#32 to work we need to ensure that we always use conventional commits in order for the changelog to be generated correctly. This patch ensures that this is the case.
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 17, 2024
In order for the automatic release process VRPirates#32 to work we need to ensure that we always use conventional commits in order for the changelog to be generated correctly. This patch ensures that this is the case.
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 18, 2024
In order for the automatic release process VRPirates#32 to work we need to ensure that we always use conventional commits in order for the changelog to be generated correctly. This patch ensures that this is the case.
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 30, 2024
This commit introduces commitlint, a tool to enforce conventional commit messages. This is crucial for the automated release process (issue VRPirates#32) to work correctly, as it relies on conventional commit messages to generate the changelog. The commit includes the following changes: - Adds `commitlint.config.js` file that defines commitlint's rules for conventional commits. This config file ensures commits adhere to the Conventional Commits specification, allowing for automated changelog generation. - Adds a `.husky/commit-msg` hook which ensures that commitlint is run before each commit. - Adds `@commitlint/cli` and `@commitlint/config-conventional` packages to `package-lock.json` to enable commitlint functionality. - Updates `package.json` to add a "commitlint" script, allowing developers to run commitlint directly. By enforcing conventional commits, this commit improves the project's workflow, making releases more reliable and automated. It ensures the changelog is accurate and consistent, making it easier for developers and users to understand the project's history and changes.
MikeRatcliffe
added a commit
to MikeRatcliffe/sidenoder
that referenced
this pull request
Sep 30, 2024
This commit introduces commitlint, a tool to enforce conventional commit messages. This is crucial for the automated release process (issue VRPirates#32) to work correctly, as it relies on conventional commit messages to generate the changelog. The commit includes the following changes: - Adds `commitlint.config.js` file that defines commitlint's rules for conventional commits. This config file ensures commits adhere to the Conventional Commits specification, allowing for automated changelog generation. - Adds a `.husky/commit-msg` hook which ensures that commitlint is run before each commit. - Adds `@commitlint/cli` and `@commitlint/config-conventional` packages to `package-lock.json` to enable commitlint functionality. - Updates `package.json` to add a "commitlint" script, allowing developers to run commitlint directly. By enforcing conventional commits, this commit improves the project's workflow, making releases more reliable and automated. It ensures the changelog is accurate and consistent, making it easier for developers and users to understand the project's history and changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #33
Adds GitHub Actions workflow for automated releases, including:
dmgfor both Intel & M1)exeAppImagedebrpmv0.9.2.This streamlines the release process and ensures consistent releases across all platforms.
Usage:
package.json.To ensure we pick up all changes we should probably add the conventional commits pre-commit hook to ensure commit messages contain the required
fix,featetc.Here is an example of the output: