Skip to content

Latest commit

 

History

History
28 lines (27 loc) · 2.41 KB

RELEASE.md

File metadata and controls

28 lines (27 loc) · 2.41 KB
Raw

Documentation for the release process of Leaflet.

Please note that you will need to have a git remote called origin that points to Leaflet's GitHub repo, since the publish script assumes it

  • Make a new release branch (for example named prepare-X.Y.Z)
  • Make sure you do not have any package.lock.json or yarn.lock locally, since they can potentially make you build with the wrong package versions
  • Update the changelog since last release and commit to the release branch
  • Write a blog post about the new release and put in /docs/_posts and commit to the release branch
  • Bump version number in package.json and commit to master
  • Run npm run release
  • Verify that the release was correctly published to NPM by checking:
  • Update API docs:
    • run npm run docs
    • Copy the built docs from dist/reference-X.Y.Z.html to docs/reference-X.Y.Z.html, remove content before first and after second "CUT HERE" comment
    • Insert YAML front matter, see old docs/reference-X.Y.Z.html for reference
    • Commit the new docs to the release branch
  • Update docs/reference.html to redirect to the new version and commit the change to the release branch
  • Update integrity hashes:
    • Checkout the release tag (git checkout vX.Y.Z)
    • Run npm run integrity or simply node ./build/integrity.js if you're not on Debian
    • Copy the hashes and update integrity_hash_css, integrity_hash_source and integrity_hash_uglified in docs/_config.yml; commit changes to the release branch
  • Update link to latest release in docs/download.html, and commit to the release branch
  • Add link to new version reference in docs/reference-versions.html, and commit to the release branch
  • Update latest_leaflet_version (and possibly latest_leaflet_reference) in docs/_config.yml and commit to the release branch
  • Update the announcement section in docs/index.html and commit to the release branch
  • If it looks like everything is good at this point, merge the release branch into master
  • Make a new release on Leaflet's GitHub release page with the most important parts of the changelog