diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 7ff8767..ab7849a 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -4,6 +4,7 @@ on: push: branches: - main + - beta jobs: setup: diff --git a/README.md b/README.md index ea0096c..34f92c1 100644 --- a/README.md +++ b/README.md @@ -148,3 +148,7 @@ Use this [terminology](https://docs.pdap.io/activities/terms-and-definitions). _n.b. There are some other scripts defined in the `package.json` `"scripts"` field, but they are mostly for CI or cleanup post-build, etc. You shouldn't need them._ + +## Releasing +Incremental updates can be added to `main` directly via a PR. +For more significant updates, the `beta` branch can be used for releasing incremental beta releases to test the bigger feature without releasing to production. \ No newline at end of file diff --git a/release.config.cjs b/release.config.cjs index cd25d45..7ea9fca 100644 --- a/release.config.cjs +++ b/release.config.cjs @@ -2,7 +2,7 @@ * @type {import('semantic-release').GlobalConfig} */ module.exports = { - branches: ['main'], + branches: ['main', { name: 'beta', channel: 'beta', prerelease: true }], plugins: [ // Run in order: // 1. Analyze commits to determine release type @@ -11,7 +11,8 @@ module.exports = { { preset: 'angular', releaseRules: [ - { type: 'docs', release: 'patch' }, + { type: 'feature', release: 'minor'}, + { type: 'docs', message: '*README*', release: 'patch' }, { type: 'refactor', release: 'patch' }, { type: 'style', release: 'patch' }, ], @@ -35,6 +36,7 @@ module.exports = { presetConfig: { types: [ { type: 'feat', section: 'Features' }, + { type: 'feature', section: 'Features' }, { type: 'fix', section: 'Bug Fixes' }, { type: 'hotfix', section: 'Bug Fixes' }, { type: 'docs', section: 'Docs' },