gitbutler/README.md

Development

Prerequisites

see here for the list of software required to build / develope the app.

Setup

Then, make sure to install app dependencies:

$ pnpm install

Run the app

Now you should be able to run the app in development mode:

$ pnpm tauri dev

By default it will not print debug logs to console. If you want debug logs, use debug feature:

$ pnpm tauri dev --features debug

Run Stories

Stories is our easy way to view our app components. Running the following command will launch in your default browser.

$ pnpm story:dev

Lint & format

Javascript:

$ pnpm lint
$ pnpm format

Rust:

$ cargo clippy   # see linting errors
$ cargo fmt      # format code

Debug

Logs

App writes logs into:

1. stdout in development mode
2. Logs directory

Tokio

We are also collecting tokio's runtime tracing information that could be viewed using tokio-console:

• developlent:

  $ tokio-console
  

• nightly:

  $ tokio-console http://127.0.0.1:6668
  

• production:

  $ tokio-console http://127.0.0.1:6667
  

Build

To build the app in production mode, run:

$ pnpm tauri build --features devtools --config packages/tauri/tauri.conf.nightly.json

This will make an asset similar to our nightly build.

Icon generation

$ pnpm tauri icon path/to/icon.png

Release

Building is done via GitHub Action. Go to the link and select Run workflow from the desired branch.

Versioning

When running the release action, 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.