Skip to content
This repository was archived by the owner on Nov 25, 2021. It is now read-only.

Conversation

dvvanessastoiber
Copy link
Contributor

Release notes

Checklists

Release preparation

  • Create new release-x.x.x branch (based on develop branch)
  • Collect changes and write release notes
  • Draft release PR in GitHub that merges the release-x.x.x into the master branch

Release dependencies first

In case of dependent Phovea/TDP repositories follow dependency tree from the top:

  • Release dependent repositories if they contain changes first before proceeding here
  • Replace git dependencies in package.json with new version range (e.g., "phovea_core": "^2.3.1" when published on npm or "phovea_core": "github:datavisyn/tdp_core#semver:^8.0.0" for non-published repositories)
  • Commit and push new dependencies
  • Wait until build is successful
  • Repeat with other repositories/dependencies or proceed with next section

Update version

  • Check version numbers of dependencies again
  • Check if build is successful
  • Update this version number following semver
  • Commit and push package.json with new version number
  • Assign reviewer and wait for final review
  • Merge this pull request into master branch
  • Add release label (i.e., release: major, release: minor, or release: patch)

Publish npm release

The steps of this section are only necessary if the code is public and should be published to the npm registry.

  • chmod -R o+w . in the cloned repository directory (to provide write access to the CircleCI Linux user)
  • rm -rf dist && rm -rf build && rm -rf node_modules/ && rm -rf package-lock.json
  • docker run -it -v $(pwd):/phovea circleci/node:12.13-buster-browsers /bin/bash and continue inside the container
  • cd /phovea
  • npm install
  • npm run build to build the bundles
  • npm login as caleydo-bot
  • npm publish
  • Check release on npmjs.com

Create GitHub release

  • Draft a new release (Code -> Releases -> Draft a new release)
  • Use new version number as tag (e.g., v2.3.1)
  • Copy release notes
  • Publish release

Prepeare next develop release

  • Switch to develop branch
  • Merge master branch into develop (git merge origin/master)
  • Update version in package.json to <next patch version>-SNAPSHOT (e.g., 2.3.1 to 2.3.2-SNAPSHOT)
  • Revert dependencies in package.json to develop branches (e.g., "phovea_core": "github:phovea/phovea_core#develop")
  • Commit and push changes

🏁 Finish line

  • Inform colleagues and customers about the release
  • Celebrate the new release 🥳

sgratzl and others added 27 commits August 6, 2019 11:10
switch to esm.js to avoid problems with .mjs
Fix plugin id to make this available on the awesome list.
@dvvanessastoiber dvvanessastoiber added the release: patch PR merge results in a new patch version label Nov 12, 2020
@dvvanessastoiber dvvanessastoiber requested a review from a user November 12, 2020 11:05
@ghost ghost merged commit 8e1ce2b into master Nov 12, 2020
@ghost ghost deleted the release-1.2.2 branch November 12, 2020 12:46
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
release: patch PR merge results in a new patch version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Center expanded parent node label
6 participants