etcher/docs/PUBLISHING.md
Juan Cruz Viotti f73bcb78a8 docs: revise PUBLISHING.md S3 section (#1197)
- Mention the production and snapshot S3 bucket
- Remove the note that `aws-s3.sh` doesn't run on Windows
- Don't document `./scripts/publish/aws-s3.sh`. Encourage maintainers to
  use `make publish-aws-s3` instead

See: https://github.com/resin-io/etcher/pull/1078#discussion_r107259159
Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
2017-03-23 22:31:18 -04:00

2.9 KiB

Publishing Etcher

This is a small guide to package and publish Etcher to all supported operating systems.

Signing

OS X

  1. Get our Apple Developer ID certificate for signing applications distributed outside the Mac App Store from the resin.io Apple account.

  2. Install the Developer ID certificate to your Mac's Keychain by double clicking on the certificate file.

The application will be signed automatically using this certificate when packaging for OS X.

Windows

  1. Get access to our code signing certificate and decryption key as a resin.io employee by asking for it from the relevant people.

  2. Place the certificate in the root of the Etcher repository naming it certificate.p12.

Packaging

OS X

Run the following command:

make electron-installer-dmg
make electron-installer-app-zip

The resulting installers will be saved to release/out.

GNU/Linux

Run the following command:

make electron-installer-appimage
make electron-installer-debian

The resulting installers will be saved to release/out.

Windows

Run the following command:

make electron-installer-zip
make electron-installer-nsis

The resulting installers will be saved to etcher-release/installers.

Publishing to Bintray

We publish GNU/Linux Debian packages to Bintray.

Make sure you set the following environment variables:

  • BINTRAY_USER
  • BINTRAY_API_KEY

Run the following command:

make publish-bintray-debian RELEASE_TYPE=<production|snapshot>

Publishing to S3

Make sure you have the AWS CLI tool installed and configured to access resin.io's production or snapshot S3 bucket.

Run the following command to publish all files for the current combination of platform and arch (building them if necessary):

make publish-aws-s3 RELEASE_TYPE=<production|snapshot>

Also add links to each AWS S3 file in GitHub Releases. See v1.0.0-beta.17 as an example.

Publishing to Homebrew Cask

  1. Update Casks/etcher.rb with the new version and sha256

  2. Send a PR with the changes above to caskroom/homebrew-cask

Announcing

Post messages to the Etcher forum and Etcher gitter channel announcing the new version of Etcher, and including the relevant section of the Changelog.