Skip to content

Update Project Maintainer README.md to reflect the new workflow

Overview

  • With a switch off of Fractal and Gulp, the Project Maintainer workflow has changed from what is outlined in the Project Maintainer README
  • The processes outlined in this file should be updated to reflect the new processes
  • Remove the gitflow README?
    • If we do that, we should also ensure any mention of gitflow is updated in the main README

Include

  • Run npm install and npm run dev to test the branch locally
  • Remove manually updating the CHANGELOG.md as that will be handled by auto-changelog
  • Use npm version to tag releases instead of Gitflow
    • patch, minor, or major depending on the release
    • This will update the version number in package.json and auto-changelog will update CHANGELOG.md
    • This also creates a new tag so we don't need to do that either
    • git push origin --tags is still used to push up
    • BUX Composer should kick off automatically too but we need to see it in practice still