Skip to content

Commit

Permalink
Add a changelog file and mention it in the maintainer instructions.
Browse files Browse the repository at this point in the history
Fixes google#148.
  • Loading branch information
tjgq committed Oct 29, 2018
1 parent 14dd750 commit 3c40676
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 3 deletions.
80 changes: 80 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
CHANGELOG

This file lists notable changes included in each Marzipano release. Please note
that only library changes are considered; changes to tests, documentation, demos
or the Marzipano Tool are not tracked.

Each change is prefixed by one of:

- `New`: a newly introduced feature.
- `Fix`: a fix to an existing bug.
- `Breaking`: a breaking change to the API.

Related GitHub issue or pull request numbers are indicated in brackets.

# Upcoming release

* New: `Stage#renderComplete` event (#40, #109, #181, #188).
* New: `TextureStore#textureStartLoad` event (#189).
* Fix: make WebGL rendering resilient to device pixel ratio changes (#196).
* Breaking: listeners are no longer called with event name as first argument.
* Breaking: remove `Layer#stage` and the `stage` Layer constructor argument.
* Breaking: remove underscore from Stage methods meant to be overridden.
* Breaking: remove ImageUrlSource utility methods for querying template string.

# v0.7.2 [2018-07-15]

* New: emit event for network error on ImageUrl (#166).
* New: allow default mouse cursors to be overridden (#158).
* Fix: export shaders as source to be compatible with module loaders (#177).
* Fix: use more conservative value for fov epsilon (#136).
* Fix: hotspot clicks not working on iOS (#173, #157).
* Fix: WebGL errors when switching renderers (#171).

# v0.7.1 [2018-02-23]

* Fix: handling of WebGlStage options.

# v0.7.0 [2018-02-23]

* New: support multiple layers per scene.
* New: allow layers to be inserted into custom position.
* Fix: disable WebGL antialiasing by default (#147).
* Fix: `Geometry#visibleTiles` no longer crashes on a null viewport.
* Fix: `Viewer#lookTo` (#126).
* Fix: layer addition/removal during scene transition.
* Breaking: remove Layer#setView.

# v0.6.0 [2017-11-04]

* Fix: generate mipmaps only for power-of-two textures.
* Fix: blending of semitransparent textures (#112).
* Fix: controls updating view shared by multiple layers (#111).
* Breaking: remove the WebGlStage `blendFunc` option.

# v0.5.5 [2017-08-30]

* Fix: hotspot clicks not working on Android (#87).

# v0.5.4 [2017-03-27]

* Fix: crash in browsers without typed array support.

# v0.5.3 [2016-12-05]

* Fix: broken equirectangular rendering.

# v0.5.2 [2016-12-01]

* New: ability to take a snapshot of the stage (#30).
* Fix: actually remove event listeners in control destructors.
* Fix: prevent bounce scroll on iOS.
* Fix: cross-domain image loading on Flash.

# v0.5.1 [2016-05-20]

* Breaking: remove the mistakenly exported `supported` API.

# v0.5.0 [2016-03-01]

* First open source release!
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,12 @@ source or test files are edited.

### Maintainer guide

Before preparing a release, make sure there are no uncommitted changes.
Before preparing a release, make sure there are no uncommitted changes and
verify that the tests pass and all of the demos work correctly.

Create a new commit to bump the version number in `package.json`, tag it
with `git tag vX.Y.Z`, and publish the tag with `git push --tags`.
Update the `CHANGELOG` file and bump the version number in `package.json`.
Create a new commit containing only the changes to these two files, tag it with
`git tag vX.Y.Z`, and push it to GitHub with `git push --tags`.

Run `npm run release` to prepare a new release.

Expand Down

0 comments on commit 3c40676

Please sign in to comment.