gitbutler/README.md

54 lines
1.6 KiB
Markdown
Raw Normal View History

2023-02-03 18:23:13 +03:00
## development
### prerequisites
2023-01-31 17:55:57 +03:00
2023-01-31 18:01:58 +03:00
[see here](https://tauri.app/v1/guides/getting-started/prerequisites)
2023-02-03 18:23:13 +03:00
for the list of software required to build / develope the app.
### setup
2023-01-31 17:55:57 +03:00
2023-02-03 18:23:13 +03:00
then, make sure to install app dependencies:
2023-01-31 17:55:57 +03:00
2023-01-31 18:01:58 +03:00
```bash
$ pnpm install
```
2023-01-31 17:55:57 +03:00
2023-02-03 18:23:13 +03:00
### run
now you should be able to run the app in development mode:
2023-01-31 18:01:58 +03:00
```bash
$ pnpm tauri dev
```
2023-02-03 12:36:51 +03:00
2023-02-03 18:23:13 +03:00
## building
to build the app in production mode, run:
```bash
$ pnpm tauri build
```
2023-02-03 12:36:51 +03:00
## releasing
2023-02-17 16:21:41 +03:00
Building is done via [GitHub Action](https://github.com/gitbutlerapp/gitbutler-client/actions/workflows/publish.yaml).
2023-02-14 17:59:48 +03:00
Go to the link and select `Run workflow` from the desired branch.
### versioning
2023-02-17 16:21:41 +03:00
When running the [release action](https://github.com/gitbutlerapp/gitbutler-client/actions/workflows/publish.yaml),
you will have to choose one of `major`, `minor`, or `patch` release type. Action will generate a new version based
on your input and current version found at `https://app.gitbutler.com/releases`.
### publishing
To publish a version that you've just build, use [Release Manager](https://gitbutler.retool.com/apps/cb9cbed6-ae0a-11ed-918c-736c4335d3af/Release%20Manager).
2023-02-03 12:36:51 +03:00
### runners
Note that to build an arm64 macos app, you need to make sure that there is at least one self-hosted runner
with `macos-aarch64` label is online [here](https://github.com/gitbutlerapp/gitbutler-client-tauri/settings/actions/runners).
If you are a lucky owner of an arm64 macos machine, feel free to [run it yourself](https://github.com/gitbutlerapp/gitbutler-client-tauri/settings/actions/runners/new).
Make sure to label it with `macos-aarch64`.