Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 1.83 KB

releasing.md

File metadata and controls

80 lines (56 loc) · 1.83 KB

Releasing @hawtio/camel-model

This document describes the release procedure for this package.

Updating Camel model

If this release is intended to upgrade the Camel model, the following must be done before the release is made.

  1. Update the Camel version <version.org.apache.camel> in pom.xml. (if not already updated by dependabot):

    - <version.org.apache.camel>4.3.0</version.org.apache.camel>
    + <version.org.apache.camel>4.4.0</version.org.apache.camel>
  2. Run the following Yarn script to update the Camel model:

    yarn generate:camel-model
  3. Commit the changes:

    git commit -m 'feat: upgrade Apache Camel model to 4.4.0'

Preliminary check

Before performing a release, first ensure that the project is ready for release by doing the following:

yarn install
yarn build
yarn test

Releasing

To release the @hawtio/camel-model package, follow these steps:

  1. Manually increase the version in package.json. (Currently, we don't use any automation tool for increasing versions yet.)

     {
       "name": "@hawtio/camel-model",
    -  "version": "3.20.6",
    +  "version": "3.21.0",
       "description": "Camel Catalog Definition Model",
  2. Commit the change and tag the version. Note we prefix v to a version in commit messages and tags.

    git commit -m v3.21.0
    git tag v3.21.0
  3. Check the contents to be packaged before the actual release is made with yarn pack command.

    $ yarn pack
    $ tar -tf package.tgz
    package/LICENSE
    package/dist/index.d.ts
    package/dist/index.js
    package/package.json

    Make sure to clean up the generated file after checking.

    git clean -f
  4. Perform the release.

    yarn release