zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/packages/docs/release.md

4.1 KiB
Raw Blame History

Release how-to

This page explains the steps needed to release a new version of maxgraph@core.

Currently, the release process is completely manual. Automation will come later based on the information provided here.

Preparation

Decide on the new version depending on the type of changes:

  • Follow semver
  • Until we release the first major version, bump the minor version if the release contains new features or breaking changes.

Check the milestone associated with the new release. Note: We always put issues related to a version into a Milestone whose name matches the version.

  • Make sure that the name of the milestone used for the new release version matches the name of the version being released. Rename it if necessary.
  • Verify that all issues related to the upcoming release are attached to the milestone. In particular, check the issues that do not have a milestone.
  • Clean up this open milestone if some issues are still open (move them to a new milestone or discard the milestone from them).
  • Close the milestone.

Changes in the source code

  • Update the version in package.json and the VERSION constant in the Client file.
  • Update the CHANGELOG to list the major changes included in the new version. Be generic and add a link to the future GitHub release that will contain detailed release notes, as shown below.
For more details, see the [0.1.0 Changelog](https://github.com/maxGraph/maxGraph/releases/tag/v0.1.0) on
the GitHub release page.
  • Make a single commit that includes the changes described above
    • use the following template for the commit message: chore(release): prepare version 0.2.0
    • push the changes

Create a git tag, prefixing the version with a v. For example, if the version is 0.2.0, run

git fetch --tags
git tag v0.2.0
git push origin v0.2.0

Publish the npm package

  • Checkout the tag that has just been created
  • From packages/core:
    • delete the dist folder
    • run npm publish

Create the GitHub release

Example: Use the maxGraph 0.1.0 release for inspiration

Create a new draft release

  • name: use the version that has just been published
  • tag: use the tag create before
  • save it as a draft

Generate the list of the major changes by using the automatically generated release notes. It is based on the labels of the merged Pull Requests included in this release and the GitHub release configuration.

If the list is incorrect (for example, an item is not in the correct category), update the label(s) or the associated Pull Request and regenerate the list.

On top of the auto-generated list, add a few words to highlight important changes. In particular, list breaking changes.

Also add links to the

  • npm package
  • GitHub milestone
  • related paragraph in the Changelog file

Before you publish the release, make sure that a discussion will be created in the Announces category when the release is published.

Publish the release.

Review the newly created discussion in the Announces category:

Update the integration examples repository

Once done, create a Pull Request in the integration examples repository to use the new release. Use PR #28 as an example.

Note: The examples will be updated automatically in the future, see the issue #27 for more details.