-
Treat Chatbot as the first Felt extension.
-
Create/configure its felt-v1 branch and prerelease stream.
-
Update package name in package.json to match the @felt/felt-chatbot or whatever pkg name team agrees on. It should publish to NPM in this space.
“How to” docs modified from
To set up and release prereleases for extensions
- Create a new branch to be the home of your previous version:
- Branch off of your main branch with the name being the current version number
- Push that branch to your remote
- Change branches back to main
- If it doesn’t already exist: Create a git tag from the latest commit on the main branch with a name of prerelease-v${previous version number}
- i.e. prerelease-v${6}
- In the new major release branch: update
packages/module/release.config.js:
- Edits to the
branches array:
- Add a new object for your new major release branch
{ name: '<branch-name>', channel: 'prerelease', prerelease: 'prerelease' }
- (optional) add a
dryRun: true
- This is recommended because it helps to prevent accidentally releasing a version that you don’t mean to
- Update
./github/workflows
- Edit the Check-pr.yml branches entry to include the branch name you used in step 1
- Edit the release.yml branches entry to include the branch name you used in step 1
- Check for any other workflows that fire for events on the main branch and edit the branches key as above
- Update
packages/module/package.json
- Update the
publishConfigs to have tags: ‘prerelease’
- Commit and push/PR changes
- (optional) create a new branch before committing so that you can PR the changes
- Make sure to include BREAKING CHANGE: in the footer of your commit, this will let semantic-release know to increment the major version number
- Verify that everything is working properly on GitHub
- Once your PR merges / commit is pushed check the CI logs to make sure that semantic release properly detected the previous version number and increments it as you expected
- If you added dryRun: true to release.config.js in step 3 remove it in a new PR/commit
- Verify that the correct versions are appearing on NPM
Jira Issue: PF-4695
Treat Chatbot as the first Felt extension.
Create/configure its felt-v1 branch and prerelease stream.
Update package name in package.json to match the
@felt/felt-chatbotor whatever pkg name team agrees on. It should publish to NPM in this space.“How to” docs modified from
To set up and release prereleases for extensions
packages/module/release.config.js:branchesarray:{ name: '<branch-name>', channel: 'prerelease', prerelease: 'prerelease' }dryRun: true./github/workflowspackages/module/package.jsonpublishConfigsto havetags: ‘prerelease’Jira Issue: PF-4695