Skip to content

Commit

Permalink
v3.0.0-beta.1
Browse files Browse the repository at this point in the history
  • Loading branch information
zachleat committed Jul 31, 2024
1 parent e6da76d commit 1ac68c8
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
21 changes: 9 additions & 12 deletions docs/release-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,12 @@
1. Check it all in and commit
1. Tag new version
1. Wait for GitHub Actions to complete to know that the build did not fail.
1. Release
- (Alpha) `npm publish --access=public --tag=canary`
- NOTE: the tag is `canary` but expects `-alpha.` suffixes in `package.json` version, read more: https://github.com/11ty/eleventy/issues/2758
- (Beta) `npm publish --access=public --tag=beta`
- (Main) `npm publish --access=public`
1. Publish a release on GitHub at https://github.com/11ty/eleventy/releases pointing to the tag of the release. Hitting the publish button on this workflow will use GitHub Actions to publish the package to npm on the correct dist-tag and includes npm package provenance for the release.

- Main release: no version suffix publishes to `latest` (default) tag on npm
- Make sure to include OpenCollective usernames for release notes here https://www.11ty.dev/supporters-for-release-notes/
- Canary release: `-alpha.` version suffix in `package.json` publishes to `canary` tag on npm: https://github.com/11ty/eleventy/issues/2758
- Beta release: `-beta.` version suffix publishes to `beta` tag on npm

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)

Expand All @@ -42,11 +43,7 @@ Unfortunate note about npm and tags (specifically `canary` here): if you push a
1. (Main) Check out the previous version git branch and add `outdated: true` to `_data/config.json` and commit/push.
1. 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
1. Fetch OpenCollective usernames for release notes https://www.11ty.dev/supporters-for-release-notes/

# Extras
# Downstream dependencies

1. Update `eleventy-base-blog`?
1. Update `eleventy-base-blog` to use new version
1. Update `11ty-website` to use new version
11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@11ty/eleventy",
"version": "3.0.0-alpha.18",
"version": "3.0.0-beta.1",
"description": "A simpler static site generator.",
"publishConfig": {
"access": "public",
Expand Down Expand Up @@ -51,8 +51,7 @@
"check-types": "tsc",
"lint-staged": "lint-staged",
"coverage": "npx c8 ava && npx c8 report --reporter=json-summary && cp coverage/coverage-summary.json docs/_data/coverage.json && node cmd.cjs --config=docs/eleventy.coverage.js",
"prepare": "husky",
"release-canary": "npm publish --tag=canary"
"prepare": "husky"
},
"author": "Zach Leatherman <[email protected]> (https://zachleat.com/)",
"repository": {
Expand Down Expand Up @@ -89,7 +88,7 @@
"@iarna/toml": "^2.2.5",
"@mdx-js/node-loader": "^3.0.1",
"@types/node": "^22.0.0",
"@vue/server-renderer": "^3.4.34",
"@vue/server-renderer": "^3.4.35",
"@zachleat/noop": "^1.0.3",
"ava": "^6.1.3",
"c8": "^10.1.2",
Expand All @@ -107,9 +106,9 @@
"react-dom": "^18.3.1",
"rimraf": "^6.0.1",
"sass": "^1.77.8",
"tsx": "^4.16.2",
"tsx": "^4.16.3",
"typescript": "^5.5.4",
"vue": "^3.4.34",
"vue": "^3.4.35",
"zod": "^3.23.8",
"zod-validation-error": "^3.3.0"
},
Expand Down

0 comments on commit 1ac68c8

Please sign in to comment.