Skip to content

Latest commit

 

History

History
45 lines (44 loc) · 3.69 KB

boosted-release-template.md

File metadata and controls

45 lines (44 loc) · 3.69 KB

Release v

  • sync with Bootstrap's release and probably wait for it;
  • npm run release-version $current_version $next_version to bump version number
    • then, if bumping a minor or major version:
      • Manually change version_short in package.json
      • Add docs version to site/data/docs-versions.yml
      • Manually change docs_version in hugo.yml and other references to the previous version
      • Update redirects in docs frontmatter (site/content/docs/_index.html?)
      • Move site/content/docs/5.x to site/content/docs/5.x+1
      • Increment site/static/docs/{version} version
      • (Major version) Manually update the version in nuget/boosted.nuspec and nuget/boosted.sass.nuspec
    • check wrong matches in CHANGELOG.md, and maybe site/content/docs/<version>/migration.md
    • ⚠️ check the package-lock.json and package.json content, only "boosted" should have its version changed!
    • ⚠️ site/content/docs/5.1/**/*.md should not always be modified
  • if the year changed recently, happy new year 🎉 but please change © year in .scss main files (reboot, grid, utilities, and main file) as well as in NOTICE.txt.
  • npm run release to compile dist, build Storybook, update SRI hashes in doc, and package the release
  • Prepare changelog:
  • Commit and push dist with a chore(release) commit message
  • Manually run BrowserStack test
  • Manually run Percy test
  • Merge (on v4-dev or main)
  • Tag your version, and push your tag
  • Pack and publish
    • npm pack
    • if you are already logged in to NPM (with a personal account, for example), you'd better use a repository scoped .npmrc file
    • Publish:
      • if you're releasing a pre-release, use --tag, e.g. for v5-alpha1 npm publish boosted-5.0.0-alpha1.tgz --tag next
      • (v4 only) npm publish --tag v4.x.y (if you forgot and v4 becomes the latest version on NPM, you can run `npm dist-tag add boosted@5.x.y latest to fix it)
      • (v5 only) npm publish
  • check release on NPM, Nuget, Packagist…
  • publish documentation on gh-pages:
    • copy ../_site to the gh-pages branch (don't forget to update Storybook as well)
    • check every index.html used as redirections to redirect to the new release
    • when bumping minor version: ensure dist URLs in examples' HTML has changed
    • double-check everything before pushing, starting by searching for forgotten old version number occurrences
  • make an announcement in GitHub Discussions (+ pin the new GH Discussion)
  • create a GitHub release:
    • attach the zip file
    • paste the CHANGELOG / Ship list in the release's description
  • make an announcement on internal communication channels 🎉
  • publish on Nuget