Skip to content

Latest commit

 

History

History
53 lines (43 loc) · 2.4 KB

release-instructions.md

File metadata and controls

53 lines (43 loc) · 2.4 KB
Raw

Dependency notes

Release Procedure

  1. (Optional) Update minor dependencies in package.json
    • npx npm-check-updates
    • or npm outdated + npm update --save
  2. If the minimum Node version changed, make sure you update package.json engines property.
    • Make sure the error message works correctly for Node versions less than 10.
      • 0.12.x+ requires Node 10+
      • 1.x+ requires Node 12+
      • 2.x+ requires Node 14+
      • 3.x+ requires Node 18+
  3. rm -rf node_modules && rm -f package-lock.json && npm install
  4. npm audit
  5. Make sure npm run check (eslint) runs okay
  6. Make sure npm run test (ava) runs okay
  7. Update version in package.json
    • (Alpha) Use -alpha.1 suffix
    • (Beta) Use -beta.1 suffix
  8. Run npm run coverage
  9. Check it all in and commit
  10. Tag new version
  11. Wait for GitHub Actions to complete to know that the build did not fail.
  12. Release
    • (Alpha) npm publish --access=public --tag=canary
      • NOTE: this was changed to alpha #2758
    • (Beta) npm publish --access=public --tag=beta
    • (Main) npm publish --access=public
  13. (Optional) Build and commit a new the eleventy-edge-cdn project to generate a new Eleventy Edge lib.

Unfortunate note about npm and tags (specifically canary here): if you push a 1.0.0-canary.x to canary (even though 2.0.0-canary.x exists), it will use the last pushed tag when you npm install from @canary (not the highest version number)

Docs/Website (Main releases only)

  1. Maybe search for -alpha. (-canary.?) or -beta. in the docs copy to update to the stable release, if applicable.
  2. Check in a new 11ty-website site with updated package.json version.
  3. Add version to 11ty-website versions.json
  4. Commit it
  5. Create a new branch for branched version
  6. (Main) Check out the previous version git branch and add outdated: true to _data/config.json and commit/push.
  7. Go to https://app.netlify.com/sites/11ty/settings/domain and set up a subdomain for it.

Release Notes on GitHub (Main releases only)

  1. Draft a new release on GitHub
  2. Fetch OpenCollective usernames for release notes https://www.11ty.dev/supporters-for-release-notes/

Extras

  1. Update eleventy-base-blog?