Skip to content

Commit ad0a4c6

Browse files
committed
Add release docs to README.md
1 parent 3fb49b3 commit ad0a4c6

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,37 +31,42 @@ Gitify currently only supports mac OS.
3131

3232
### Development
3333

34-
First you will need to set the testing `CLIENT_ID` and `CLIENT_SECRET` in `src/js/utils/constants.js` file. You can use the development app credentials (use at your own discretion):
34+
Optional: If you want you use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default "development" keys (use at your own discretion).
3535

36-
Client Id: 3fef4433a29c6ad8f22c
37-
Client Secret Key: 9670de733096c15322183ff17ed0fc8704050379
36+
OAUTH_CLIENT_ID="123" OAUTH_CLIENT_SECRET="456789" yarn build
3837

39-
To watch for changes in the `src` directory:
38+
To watch for changes(`webpack`) in the `src` directory:
4039

4140
yarn run watch
4241

4342
To run the actual **electron app**:
4443

4544
yarn start
4645

47-
### Distribution
46+
### Releases
4847

49-
To prepare the app for distribution run:
48+
The release process is automated. Follow the steps below.
5049

51-
yarn run build
52-
yarn run pack
53-
yarn run make:macos
50+
1. Create a [new **draft** release](https://github.com/manosim/gitify/releases/new). Set the tag version to something with the format of `v1.2.3`. Save as a **draft**.
51+
2. Once everything is merged to `master`, create a branch that starts with `releases/vX.X.X` (ie. `releases/v1.2.3`).
52+
3. In the same branch, bump the version of the app in the `package.json` file and open a PR.
53+
4. GitHub Actions will build all branches named `releases/vX.X.X` and if there is a draft release with the same number(`package.json`), it will build, sign and upload the assets to that GitHub release.
54+
5. Merge your release branch into `master`.
55+
6. Publish the draft release once you've added notes to it and all assets are there.
5456

5557
### Tests
5658

57-
There are 2 linters for `js` & `scss` and unit tests with `jest`.
59+
There are 2 checks - one for prettier and one for the unit testslinters for `js` and unit tests with `jest`.
5860

59-
// Run only unit tests
60-
yarn run jest
61+
// Run prettier to check
62+
yarn run prettier-check
6163

6264
// Run linter & unit tests with coverage
6365
yarn run test
6466

67+
// Run jest directly - allows to pass arguments like `--watch`
68+
yarn run jest
69+
6570
### FAQ
6671

6772
#### My notifications aren't showing?

0 commit comments

Comments
 (0)