diff --git a/.changeset/config.json b/.changeset/config.json index ba9dbcc3..93d85fc7 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -8,7 +8,7 @@ "fixed": [], "linked": [], "access": "public", - "baseBranch": "main", + "baseBranch": "beta", "updateInternalDependencies": "patch", "ignore": [] } diff --git a/.changeset/mean-tools-hammer.md b/.changeset/mean-tools-hammer.md new file mode 100644 index 00000000..03da4dd0 --- /dev/null +++ b/.changeset/mean-tools-hammer.md @@ -0,0 +1,5 @@ +--- +"@stackoverflow/stacks-editor": patch +--- + +Add beta publishing information to README diff --git a/.changeset/pre.json b/.changeset/pre.json new file mode 100644 index 00000000..59686c48 --- /dev/null +++ b/.changeset/pre.json @@ -0,0 +1,11 @@ +{ + "mode": "pre", + "tag": "beta", + "initialVersions": { + "@stackoverflow/stacks-editor": "0.15.3" + }, + "changesets": [ + "mean-tools-hammer", + "wise-horses-wear" + ] +} diff --git a/.changeset/wise-horses-wear.md b/.changeset/wise-horses-wear.md new file mode 100644 index 00000000..a73269ac --- /dev/null +++ b/.changeset/wise-horses-wear.md @@ -0,0 +1,5 @@ +--- +"@stackoverflow/stacks-editor": major +--- + +enter prerelease mode for project shine diff --git a/.husky/.gitignore b/.husky/.gitignore deleted file mode 100644 index 31354ec1..00000000 --- a/.husky/.gitignore +++ /dev/null @@ -1 +0,0 @@ -_ diff --git a/.husky/commit-msg b/.husky/commit-msg deleted file mode 100755 index e9bee275..00000000 --- a/.husky/commit-msg +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/sh -. "$(dirname "$0")/_/husky.sh" - -# only run the commit message check if the commit is against the main branch -if [[ $(git rev-parse --abbrev-ref HEAD) = main ]]; -then npx --no -- commitlint --edit "${1}"; -fi diff --git a/.prettierignore b/.prettierignore index dbccff9c..a0ee75d1 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,4 +2,5 @@ .vscode/ stats.json dist/ -test-results/ \ No newline at end of file +test-results/ +.changeset/ diff --git a/CHANGELOG.md b/CHANGELOG.md index daeebcb5..76b43897 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## 1.0.0-beta.1 + +### Patch Changes + +- [#475](https://github.com/StackExchange/Stacks-Editor/pull/475) [`73e4b6e`](https://github.com/StackExchange/Stacks-Editor/commit/73e4b6e0191b25518b52e015d63b4853ea330f34) Thanks [@ttaylor-stack](https://github.com/ttaylor-stack)! - Add beta publishing information to README + +## 1.0.0-beta.0 + +### Major Changes + +- enter prerelease mode for project shine + ## 0.15.3 ### Patch Changes diff --git a/README.md b/README.md index 575d2974..8e611219 100644 --- a/README.md +++ b/README.md @@ -98,3 +98,20 @@ We use [changesets](https://github.com/changesets/changesets) to automatize the _The release github workflow only run if the CI workflow (running linter, formatter and tests) is successful: CI is blocking accidental releases_. _Despite using changesets to communicate the intent of creating releases in a more explicit way, we still follow [conventional commits standards](https://www.conventionalcommits.org/en/v1.0.0/) for keeping our git history easily parseable by the human eye._ + +### Beta publishing + +We use Changesets in prerelease mode to manage publishing to the beta branch. For more information, please refer to the official [Changesets prerelease documentation](https://github.com/changesets/changesets/blob/main/docs/prereleases.md). + +To prepare a beta release, follow these steps: + +1. Create a pull request (PR) targeting the beta branch. + +2. Ensure your PR includes a changeset. + +3. Merging the PR will trigger the release-beta workflow. This workflow creates or updates a chore(new-beta-release) PR. + +4. To cut a new beta release, merge the chore(new-beta-release) PR and wait for the `Release Beta` workflow to complete. + +Consumers can install the beta package by targeting the beta tag: +`npm install @stackoverflow/stacks-editor@beta` \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 5609703c..bf5a4ab5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@stackoverflow/stacks-editor", - "version": "0.15.3", + "version": "1.0.0-beta.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@stackoverflow/stacks-editor", - "version": "0.15.3", + "version": "1.0.0-beta.1", "license": "MIT", "dependencies": { "@lezer/highlight": "^1.2.0", @@ -53,7 +53,6 @@ "highlight.js": "^11.9.0", "html-loader": "^5.0.0", "html-webpack-plugin": "^5.6.0", - "husky": "^9.0.11", "jest": "^29.7.0", "jest-environment-jsdom": "^29.7.0", "liquidjs-loader": "^1.0.1", @@ -7095,22 +7094,6 @@ "node": ">=10.17.0" } }, - "node_modules/husky": { - "version": "9.1.7", - "resolved": "https://registry.npmjs.org/husky/-/husky-9.1.7.tgz", - "integrity": "sha512-5gs5ytaNjBrh5Ow3zrvdUUY+0VxIuWVL4i9irt6friV+BqdCfmV11CQTWMiBYWHbXhco+J1kHfTOUkePhCDvMA==", - "dev": true, - "license": "MIT", - "bin": { - "husky": "bin.js" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/typicode" - } - }, "node_modules/hyperdyperid": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/hyperdyperid/-/hyperdyperid-1.2.0.tgz", diff --git a/package.json b/package.json index a5b21f75..e03e45a4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@stackoverflow/stacks-editor", - "version": "0.15.3", + "version": "1.0.0-beta.1", "description": "", "repository": { "type": "git", @@ -45,8 +45,7 @@ "test:e2e": "npx playwright test --config config/playwright.config.ts", "release": "npm run build && changeset publish", "version": "changeset version && npm install --package-lock-only", - "prepublishOnly": "npm run build && tsc --module ES6 --sourceMap false", - "prepare": "husky install" + "prepublishOnly": "npm run build && tsc --module ES6 --sourceMap false" }, "keywords": [], "author": "Stack Exchange Inc", @@ -65,10 +64,10 @@ ] }, "devDependencies": { - "@commitlint/cli": "^19.2.1", - "@commitlint/config-conventional": "^19.1.0", "@changesets/changelog-github": "^0.5.1", "@changesets/cli": "^2.28.1", + "@commitlint/cli": "^19.2.1", + "@commitlint/config-conventional": "^19.1.0", "@playwright/test": "^1.42.1", "@stackoverflow/commitlint-config": "^1.0.0", "@stackoverflow/prettier-config": "^1.0.0", @@ -88,7 +87,6 @@ "highlight.js": "^11.9.0", "html-loader": "^5.0.0", "html-webpack-plugin": "^5.6.0", - "husky": "^9.0.11", "jest": "^29.7.0", "jest-environment-jsdom": "^29.7.0", "liquidjs-loader": "^1.0.1", diff --git a/site/layout.html b/site/layout.html index 7de4b59b..8c50382c 100644 --- a/site/layout.html +++ b/site/layout.html @@ -3,7 +3,7 @@ - Stacks Editor + [BETA] Stacks Editor -

Stacks Editor

+

Stacks Editor Beta

Showcasing our new editing experience for Stack Overflow

{% endblock %}