Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.35 KB

RELEASING.md

File metadata and controls

57 lines (39 loc) · 2.35 KB

Releasing Reveal involves releasing NPM packages @cognite/reveal and/or updating documentation. The documentation is automatically deployed when pushed to master.

Publishing packages

Publishing of new packages to NPM is handled automatically by a Github Actions workflow which is triggered when publishing a new release on GitHub. The only consideration you need to make when publishing a new release, is that the NPM package version must be unique meaning that the package version has not been released previously.

Updating latest documentation

To update the documentation with any changes that might have been added since the last release:

Assuming you are at the root of the project navigate do the documentation folder and run the update script

cd documentation

# replaces the 'latest' documentation by the 'next'
yarn replace-latest-by-next

  1. Commit these changes

  2. Create a PR with the changes.

Once the PR is merged into master, the documentation will be automatically deployed.

Create a release on GitHub

  1. Go to https://github.com/cognitedata/reveal/releases/new
  2. Under the "Tag version" field, add a new tag for this release with the name and version of the package, e.g. @cognite/[email protected]
  3. Specify the same release title as the tag name.
  4. Write the changes that new version brings. Get inspired by done tasks from your sprint board. Note! Remember to specify the correct ThreeJS version required by the released version - you can find this in package.json of the viewer. Also, you can check what's committed from the previous tag with that command: 
    git log --pretty=format:"* %s" @cognite/[email protected]
    Use the following template:
Reveal comes with ThreeJS embedded so you do not have this as a dependency in your project. If you still want to have it as a direct dependency, it must match the version used by Reveal (r<THREEJS_VERSION>). You can also use three.js version exported by Reveal as import { THREE } from '@cognite/reveal.

### 🚀 Features

* commit message

### 🐞 Bug fixes and enhancements

* commit message

### 📖 Documentation

* commit message

See [installation documentation](https://cognitedata.github.io/reveal-docs/docs/installation) for details about installing Reveal.
  1. Hit the green "Publish release" button