-
Notifications
You must be signed in to change notification settings - Fork 58
DoD for release
Julien Déramond edited this page Sep 17, 2021
·
59 revisions
- Run linters;
- Run compilers;
- Run tests;
- Check documentation site: examples and contents;
- Test cross-browser compatibility locally and with BrowserStack:
- Firefox ESR
- IE11 (v4 only)
- Latest Edge, Chrome, Firefox, Safari
- iOS Safari
- Chrome & Firefox on Android
- Including RTL mode;
- Ask for reviews and accessibility testing;
- sync with Bootstrap's release and probably wait for it;
-
npm run release-version $current_version $next_versionto bump version number- then, if bumping a minor or major version:
- Manually change
version_shortinpackage.json - Add docs version to
site/data/docs-versions.yml - Manually change
docs_versioninconfig.ymland other references to the previous version - Update redirects in docs frontmatter (
site/content/docs/_index.html?) - Move
site/content/docs/5.xtosite/content/docs/5.x+1 - Increment
site/static/docs/{version}version - Increment version in
nuget/boosted.nuspec - Ensure Algolia indexes new release content (probably requires a PR)
- Manually change
- check wrong matches in
CHANGELOG.md, and maybesite/content/docs/<version>/migration.md ⚠️ check thepackage-lock.jsonandpackage.jsoncontent, only "boosted" should have its version changed!- manually update the version in
nuget/boosted.nuspecandnuget/boosted.sass.nuspec ⚠️ site/content/docs/5.1/**/*.mdshould not always be modified
- then, if bumping a minor or major version:
- if year changed recently, happy new year 🎉 but please change © year in
.scssmain files (reboot, grid, utilities and main file) as well as inNOTICE.txt. -
npm run releaseto compile dist, update SRI hashes in doc and package the release - Prepare changelog:
- install Conventionnal Changelog and
conventional-changelog-cliglobally - run
conventional-changelog -p angular -i CHANGELOG.md -s - and probably maintain a ship list (eg for v4.4.0)
- install Conventionnal Changelog and
- commit and push
distwith achore(release)commit message - merge (on
v4-devormain) - tag your version, and push your tag
- create a GitHub release:
- attach zip file
- paste CHANGELOG / Ship list in the release's description
- run
build/ship.sh x.x.xto… (v4 only)- Pull the latest changes update new version numbers
- Compile CSS and JS
- Compress dist files
- Generate the hashes and update our config's cdn section
- Compile the docs
- Copy-pasta built docs to
bs-docs-named clone of Boosted.
-
npm packthennpm publish- if you are already logged in NPM (with a personnal account, for example), you'd better use a repository scoped
.npmrcfile - if you're releasing a pre-release, use
--tag, eg for v5-alpha1npm publish boosted-5.0.0-alpha1.tgz --tag next
- if you are already logged in NPM (with a personnal account, for example), you'd better use a repository scoped
- publish on Nuget
- check release on NPM, Nuget, Packagist…
- publish documentation on
gh-pages:- copy
../_site(main) or../bs-docs(v4-dev) to thegh-pagesbranch - check every
index.htmlused as redirections to be redirecting to the new release - when bumping minor version: ensure
distURLs in examples' HTML has changed - double-check everything before pushing, starting by searching for forgotten old version number occurences
- copy
- make an announcement in Plazza 🎉