Merge pull request #39 from matrix-org/travis/release-notes

Add rudimentary docs for releases

Author: turt2live

docs/releases.md

@@ -0,0 +1,26 @@
+# Cutting releases
+
+While this project is considered unstable/beta quality, the following steps should be taken:
+
+1. Ensure all changes are merged and that `master` is locally updated.
+2. Ensure you're logged in as the `matrixdotorg` npm user (for at least the project). `npm whoami` will tell you this.
+3. Run `npm version 0.1.0-beta.15` (using whatever beta number is next).
+4. Push `master` and the created `v0.1.0-beta.15` tag
+5. Run `npm publish` to update npm
+6. Run `npm dist-tag add [email protected] beta` to add the `beta` tag to the npm release.
+7. Go to https://github.com/matrix-org/matrix-widget-api/releases/new?tag=v0.1.0-beta.15 and use the following template for the notes:
+   ```
+   Changes since v0.1.0-beta.14:
+
+   * Add support for disabling modal buttons by default, optionally.
+   ```
+
+   **Mark the release as a pre-release.**
+8. Publish the release.
+
+Now, for the consumer update steps:
+
+1. `yarn add matrix-widget-api@beta` in the react-sdk, likely on the PR branch that is trying to use the updated dependency.
+2. Push the react-sdk changes to `develop` - this is important to keep the lockfile for element-web sane.
+3. `yarn add matrix-widget-api@beta` in element-web, double checking that the lockfile upgraded rather than appended the version.
+4. Push the element-web changes to `develop`