You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-12Lines changed: 17 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,37 +31,42 @@ Gitify currently only supports mac OS.
31
31
32
32
### Development
33
33
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).
To watch for changes(`webpack`) in the `src` directory:
40
39
41
40
yarn run watch
42
41
43
42
To run the actual **electron app**:
44
43
45
44
yarn start
46
45
47
-
### Distribution
46
+
### Releases
48
47
49
-
To prepare the app for distribution run:
48
+
The release process is automated. Follow the steps below.
50
49
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.
54
56
55
57
### Tests
56
58
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`.
58
60
59
-
// Run only unit tests
60
-
yarn run jest
61
+
// Run prettier to check
62
+
yarn run prettier-check
61
63
62
64
// Run linter & unit tests with coverage
63
65
yarn run test
64
66
67
+
// Run jest directly - allows to pass arguments like `--watch`
0 commit comments