jeans/etcher
jeans/etcher
1
0
Fork 0
mirror of https://github.com/balena-io/etcher.git synced 2025-04-23 06:47:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
etcher/docs/MAINTAINERS.md
Juan Cruz Viotti 24f442a8fc docs(MAINTAINERS.md): steps to upgrade electron (#501) 
This PR documents the process to upgrade the Electron version correctly,
in order to prevent any potential compatibility issue when building
native dependencies.

Signed-off-by: Juan Cruz Viotti <jviottidc@gmail.com>
2016-06-22 10:40:45 -04:00

1.8 KiB
Raw Permalink Blame History

Maintaining Etcher

This document is meant to serve as a guide for maintainers to perform common tasks.

Preparing a new version

  • Bump the version number in the package.json's version property.

  • Bump the version number in the package.json's builder.win.version property.

  • Add a new entry to CHANGELOG.md describing what has been added, changed, or removed. Please use the imperative mode and capitalize the first letter of each item.

  • Link the CHANGELOG.md entry to the GitHub page displaying the diffs between the previous and the current version.

https://github.com/resin-io/etcher/compare/<previous>...<current>

  • Re-take screenshot.png so it displays the latest version in the bottom right corner.

  • Re-install all dependencies and run npm shrinkwrap to update npm-shrinkwrap.json.

  • Commit the changes with the version number as the commit title, including the v prefix, to master. For example:

git commit -m "v1.0.0" # not 1.0.0
  • Create an annotated tag for the new version. The commit title should equal the annotated tag name. For example:
git tag -a v1.0.0 -m "v1.0.0"
  • Push the commit and the annotated tag.
git push
git push --tags

Upgrading Electron

  • Upgrade the electron-prebuilt dependency version in package.json to an exact version (no ~, ^, etc).

  • Find the exact NodeJS version included in the desired Electron version and update engines.node in package.json appropriately. This can be usually found in the Electron releases page.

  • Update the NODE_VERSION environment variable in .travis.yml.

  • Update the nodejs_version and npm_config_target environment variables in appveyor.yml.