Skip to content

Set up Felt Chatbot development branch and prerelease workflow #918

Description

@patternfly-jira-sync
  • 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

  1. Create a new branch to be the home of your previous version:
  2. Branch off of your main branch with the name being the current version number
  3. Push that branch to your remote
  4. Change branches back to main
  5. 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}
  6. i.e. prerelease-v${6}
  7. In the new major release branch: update packages/module/release.config.js:
  8. Edits to the branches array:
  9. Add a new object for your new major release branch
  10. ​​{ name: '<branch-name>', channel: 'prerelease', prerelease: 'prerelease' }
  11. (optional) add a dryRun: true 
  12. This is recommended because it helps to prevent accidentally releasing a version that you don’t mean to
  13. Update ./github/workflows
  14. Edit the Check-pr.yml branches entry to include the branch name you used in step 1
  15. Edit the release.yml branches entry to include the branch name you used in step 1
  16. Check for any other workflows that fire for events on the main branch and edit the branches key as above
  17. Update packages/module/package.json
  18. Update the publishConfigs to have tags: ‘prerelease’
  19. Commit and push/PR changes
  20. (optional) create a new branch before committing so that you can PR the changes
  21. Make sure to include BREAKING CHANGE: in the footer of your commit, this will let semantic-release know to increment the major version number
  22. Verify that everything is working properly on GitHub
  23. 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
  24. If you added dryRun: true to release.config.js in step 3 remove it in a new PR/commit
  25. Verify that the correct versions are appearing on NPM

Jira Issue: PF-4695

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions