Skip to content

Latest commit

 

History

History
50 lines (49 loc) · 4.09 KB

ouds-release-template.md

File metadata and controls

50 lines (49 loc) · 4.09 KB

Release v

  • npm run release-version $current_version $next_version to bump version number
    • then, if bumping a minor or major version:
      • Manually search and replace $current_version in all files, meaning changes should happen in:
        • The style sheet loaded in .storybook/preview-head.html
        • docs_version in config.yml and other references to the previous version
        • scss/docs.scss
        • Several markdown files and markdown extended files
        • Add docs version to site/data/docs-versions.yml
        • Make sure the migration guide is updated only for the next version
        • (Major version) Manually update the version in nuget/ouds-web.nuspec and nuget/ouds-web.sass.nuspec
        • Check that the changes in the migration guide only apply to the latest version
      • Update the home news for the next release
    • check wrong matches in CHANGELOG.md, and maybe site/content/docs/<version>/migration.md
    • ⚠️ check the package-lock.json and package.json content, only "@ouds/web" should have its version changed!
  • 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:
    • install Conventional Changelog and conventional-changelog-cli globally
    • run conventional-changelog -p angular -i CHANGELOG.md -s
    • Make sure to import all the bad named commits
  • Commit and push dist with a chore(release): vx.y.z commit message
  • Merge on ouds/main
  • Tag your version, and push your tag using git tag vx.y.z-ouds-web and git push vx.y.z-ouds-web
  • Pack and publish for the common part and all the brands
    • 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 v1-alpha1 npm publish ouds-web-1.0.0-alpha1.tgz --tag next
      • npm publish --access public
  • check release on NPM, Nuget, Packagist…
  • publish documentation on main of the ouds-web-doc repo:
    • run npm run storybook-build (be careful that release-sri doesn't update config.ymls)
    • remove storybook folder from ouds-web-doc
    • copy ../_site to the main branch
    • check every index.html used as redirections to redirect to the new release
    • when bumping minor or major version: ensure dist URLs in examples' HTML has changed
    • double-check everything before pushing, starting by searching for forgotten old version number occurrences
    • Make the new release banner appears in the previous version of the doc (e.g. in v5.3 when releasing the v5.4.0 doc)
  • create a GitHub release:
    • attach the 2 zip files per brand
    • paste the CHANGELOG / Ship list in the release's description