GAP Secret Editor

Secret and config editor with GUI for Emarsys applications in Google Application Platform

Prerequisites

Install (or update) gcloud, and connect to the staging and production clusters. More info in GAP docs.

Installation

Download the application from the releases page of the GitHub repository.

For macOS download the .dmg file, double-click on it, and drag the "GAP Secret Editor" icon onto "Applications". For Windows download the .exe file and double-click on it.

Logging

Application logs can be found in the following directory:

• For macOS: ~/Library/Logs/gap-secret-editor/
• For Windows: %USERPROFILE%\AppData\Roaming\gap-secret-editor\logs

For developers

# set appropriate NodeJS version
nvm use

# install dependencies
npm ci

# start application locally
npm run start-dev

# run all tests (with npm audit and linter checks)
npm test

# run only unit tests once
npm run test:once

# run only unit tests in watch mode
npm run test:watch

# build electron application
npm run build

# build, sign and release electron application
npm run release

Releasing a new version using CI

Increase the version number in package.json and package-lock.json then commit it. The commit message must begin with release v (e.g. release v1.2.3). Push the commit and wait for the CI to test and build the app. At the end, the CI will create a draft release under the releases page, which you have to edit and publish manually.

Note: The actual release number is based on the value in package.json, but it sounds a good idea to use the same value in the commit message, as well.

Secrets used in CI for releasing

Secrets are set following the steps described in Releasing a new version locally with one exception: the value of CSC_LINK is not the path to the certificate, but the base64 encoded certificate itself. More info

Releasing a new version locally

To build the application locally, you only need to run npm run build. However, to sign and release it, some additional setup is required:

• to sign the application you need a certificate
  • download the certificate from secret server
    • DO NOT download into the project directory, so you will not commit it accidentally
  • set the CSC_LINK environment variable to the path of the downloaded certificate
  • set the CSC_KEY_PASSWORD environment variable to the password of the certificate
• after the application is signed, it has to be notarized by apple
  • make sure you have a personal Apple ID, and with that you are a member of the team (at https://developer.apple.com) who issued the certificate above
  • set the APPLEID environment variable to your apple id
  • set the APPLEIDPASS environment variable to the password of your apple id
    • it is highly recommended to generate and use an application specific password
  • install the latest Xcode
• after the application is signed and notarized, you have to publish it as a new release
  • set the GH_TOKEN environment variable to you GitHub Token
    • make sure the token has access to the repo role (and all its sub-roles)

If you set all the environment variables above, increase the version number in package.json and run npm run release.

(Note: the scripts usually hangs for a couple of minutes at the notarization step (just after "signing"), be patient and wait for the apple servers to do their job)

The script will create a draft release under the releases page, which you have to edit and publish manually.

---

This project was generated with electron-vue@45a3e22 using vue-cli. Documentation about the original structure can be found here.

The application icon is based on the icon made by Gregor Cresnar from www.flaticon.com.