aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLibravatar Vijay A <avijayr@protonmail.com>2021-06-06 16:52:07 +0530
committerLibravatar Vijay A <avijayr@protonmail.com>2021-06-06 16:52:07 +0530
commit5362837e7ff2eaf1b4cf97edb3590fd1de068451 (patch)
treea8d22a89cd6350aa874c5850d97cab87621460e9 /CONTRIBUTING.md
parentExtracted common string into constant. (diff)
downloadferdium-app-5362837e7ff2eaf1b4cf97edb3590fd1de068451.tar.gz
ferdium-app-5362837e7ff2eaf1b4cf97edb3590fd1de068451.tar.zst
ferdium-app-5362837e7ff2eaf1b4cf97edb3590fd1de068451.zip
Added missing documentation around self-signing for local testing of packaged apps on macos [skip ci]
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 947428c7b..7fcc868c2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -23,7 +23,8 @@
23 - [Install dependencies](#install-dependencies) 23 - [Install dependencies](#install-dependencies)
24 - [Fix native modules to match current electron node version](#fix-native-modules-to-match-current-electron-node-version) 24 - [Fix native modules to match current electron node version](#fix-native-modules-to-match-current-electron-node-version)
25 - [Package recipe repository](#package-recipe-repository) 25 - [Package recipe repository](#package-recipe-repository)
26 - [Using Docker to build an rpm package](#using-docker-to-build-an-rpm-package) 26 - [Using Docker to build a linux-targetted packaged app](#using-docker-to-build-a-linux-targetted-packaged-app)
27 - [Code Signing on a mac](#code-signing-on-a-mac)
27 - [Start development app](#start-development-app) 28 - [Start development app](#start-development-app)
28 - [Styleguide](#styleguide) 29 - [Styleguide](#styleguide)
29 - [Git Commit Messages format](#git-commit-messages-format) 30 - [Git Commit Messages format](#git-commit-messages-format)
@@ -133,7 +134,7 @@ Ferdi requires its recipes to be packaged before it can use it. When running Fer
133cd recipes && npm i && npm run package 134cd recipes && npm i && npm run package
134``` 135```
135 136
136### Using Docker to build an rpm package 137### Using Docker to build a linux-targetted packaged app
137 138
138```bash 139```bash
139docker build -t ferdi-package . 140docker build -t ferdi-package .
@@ -157,6 +158,20 @@ mv /ferdi/ferdi /ferdi-out/Ferdi-$GIT_SHA
157mv /ferdi/latest-linux.yml /ferdi-out/latest-linux-$GIT_SHA.yml 158mv /ferdi/latest-linux.yml /ferdi-out/latest-linux-$GIT_SHA.yml
158``` 159```
159 160
161### Code Signing on a mac
162
163If you are building the packaged app (on a mac) for local testing, you can set this environment variable to bypass the code signing step during the packaging process (`npm run build`):
164
165```bash
166export CSC_IDENTITY_AUTO_DISCOVERY=false
167```
168
169Or else, if you want to self-sign on a mac with non-registered certificate (not for distribution of the resulting package), you can follow [this thread](https://github.com/electron/electron/issues/7476#issuecomment-356084754) and run this command:
170
171```bash
172codesign --deep --force --verbose --sign - node_modules/electron/dist/Electron.app
173```
174
160### Start development app 175### Start development app
161 176
162Run these two commands **simultaneously** in different terminals: 177Run these two commands **simultaneously** in different terminals: