Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: Add commit-lint and Commitizen #37

Closed
wants to merge 10 commits into from

Conversation

MikeRatcliffe
Copy link

@MikeRatcliffe MikeRatcliffe commented Sep 15, 2024

Fixes #36

Pull request order:

#18 -> #19 -> #20 -> #21 -> #22 -> #29 -> #37

In order for the automatic release process #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: Battery not displayed properly

build: Add eslint
@MikeRatcliffe MikeRatcliffe force-pushed the add-commitlint branch 2 times, most recently from dab2c8c to 68feb01 Compare September 17, 2024 13:46
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.
fix: Properly close `adb` and `rclone` on exit

Fixes VRPirates#34

Cleanly closes `adb` and `rclone` connections when the application exits, ensuring resources are freed and preventing potential issues. This addresses a previous oversight where these connections weren't properly closed, potentially leading to resource leaks or unexpected behavior.

Even though we free up the adb connection we don't close the server because other programs may be using the connection.
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add commit-lint
1 participant