From c9feea2f52504186671d04daeecbb1b947a99d76 Mon Sep 17 00:00:00 2001 From: Cody Olsen <81981+stipsan@users.noreply.github.com> Date: Mon, 10 Jun 2024 11:05:57 +0200 Subject: [PATCH] fix!: require `semantic-release` v24 (#128) --- .github/renovate.json | 5 +---- .github/workflows/ci.yml | 4 ++-- .github/workflows/prettier.yml | 4 ++-- .releaserc.json | 2 +- README.md | 2 +- index.js | 30 +++++++++++++++--------------- package-lock.json | 16 ++++++++++++++-- package.json | 10 +++------- 8 files changed, 39 insertions(+), 34 deletions(-) diff --git a/.github/renovate.json b/.github/renovate.json index bf51289..06f0443 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -1,9 +1,6 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", - "extends": [ - "github>sanity-io/renovate-config", - "github>sanity-io/renovate-config:automerge" - ], + "extends": ["github>sanity-io/renovate-config", "github>sanity-io/renovate-config:automerge"], "packageRules": [ { "matchPackageNames": ["semantic-release-license"], diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cd0bf90..3eff813 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,12 +17,12 @@ on: workflow_dispatch: inputs: test: - description: 'Run tests' + description: "Run tests" required: true default: true type: boolean release: - description: 'Publish new release' + description: "Publish new release" required: true default: false type: boolean diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml index c83a856..6b27c74 100644 --- a/.github/workflows/prettier.yml +++ b/.github/workflows/prettier.yml @@ -47,7 +47,7 @@ jobs: author: github-actions <41898282+github-actions[bot]@users.noreply.github.com> body: I ran `npm run prettier` 🧑‍💻 branch: actions/prettier-if-needed - commit-message: 'chore(prettier): 🤖 ✨' + commit-message: "chore(prettier): 🤖 ✨" labels: 🤖 bot - title: 'chore(prettier): 🤖 ✨' + title: "chore(prettier): 🤖 ✨" token: ${{ steps.generate-token.outputs.token }} diff --git a/.releaserc.json b/.releaserc.json index 147049e..ef5e96a 100644 --- a/.releaserc.json +++ b/.releaserc.json @@ -1,5 +1,5 @@ { "extends": "./index.js", - "branches": ["main", { "name": "canary", "prerelease": true }], + "branches": ["main", {"name": "canary", "prerelease": true}], "tagFormat": "@sanity/semantic-release-preset@${version}" } diff --git a/README.md b/README.md index 7e56671..7b15df9 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Then use this config: ```json { "extends": "@sanity/semantic-release-preset", - "branches": ["main", { "name": "beta", "prerelease": true }] + "branches": ["main", {"name": "beta", "prerelease": true}] } ``` diff --git a/index.js b/index.js index 6828870..1f27f82 100644 --- a/index.js +++ b/index.js @@ -8,8 +8,8 @@ const preset = 'conventionalcommits' **/ const options = { plugins: [ - ['@semantic-release/commit-analyzer', { preset }], - ['@semantic-release/release-notes-generator', { preset }], + ['@semantic-release/commit-analyzer', {preset}], + ['@semantic-release/release-notes-generator', {preset}], [ '@semantic-release/changelog', { @@ -18,20 +18,20 @@ const options = { # 📓 Changelog All notable changes to this project will be documented in this file. See -[Conventional Commits](https://conventionalcommits.org) for commit guidelines.` - } +[Conventional Commits](https://conventionalcommits.org) for commit guidelines.`, + }, ], [ '@semantic-release/exec', { - prepareCmd: 'npx -y prettier --write CHANGELOG.md' - } + prepareCmd: 'npx -y prettier --write CHANGELOG.md', + }, ], [ '@semantic-release/npm', { - tarballDir: '.semantic-release' - } + tarballDir: '.semantic-release', + }, ], 'semantic-release-license', [ @@ -43,10 +43,10 @@ All notable changes to this project will be documented in this file. See 'package-lock.json', 'package.json', 'pnpm-lock.yaml', - 'yarn.lock' + 'yarn.lock', ], - message: 'chore(release): ${nextRelease.version} [skip ci]' - } + message: 'chore(release): ${nextRelease.version} [skip ci]', + }, ], [ '@semantic-release/github', @@ -56,10 +56,10 @@ All notable changes to this project will be documented in this file. See // These features currently frequently leads to GitHub API rate limit errors, so we disable them for now. releasedLabels: false, // @TODO remove this before releasing on main - successComment: false - } - ] - ] + successComment: false, + }, + ], + ], } module.exports = options diff --git a/package-lock.json b/package-lock.json index 639e8a3..b28f959 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,16 +16,16 @@ "semantic-release-license": "^1.0.3" }, "devDependencies": { + "@sanity/prettier-config": "^1.0.2", "ls-engines": "0.9.1", "prettier": "^3.3.1", - "prettier-plugin-packagejson": "^2.5.0", "semantic-release": "^24.0.0" }, "engines": { "node": ">= 20.8" }, "peerDependencies": { - "semantic-release": "^22.0.12 || ^23.0.2 || ^24.0.0" + "semantic-release": "^24" } }, "node_modules/@babel/code-frame": { @@ -577,6 +577,18 @@ "node": ">=12" } }, + "node_modules/@sanity/prettier-config": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@sanity/prettier-config/-/prettier-config-1.0.2.tgz", + "integrity": "sha512-V4HinfhMYxQoyXefJ2B8zJnwlf7A8mVzAzKk24B/iCg4pkVlMGc8bj0buu9Uieh4bNeHvEAHOIQv+Xd7tiLuNA==", + "dev": true, + "dependencies": { + "prettier-plugin-packagejson": "^2.5.0" + }, + "peerDependencies": { + "prettier": "^3.2.5" + } + }, "node_modules/@sec-ant/readable-stream": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/@sec-ant/readable-stream/-/readable-stream-0.4.1.tgz", diff --git a/package.json b/package.json index 6b3d125..acf6eb4 100644 --- a/package.json +++ b/package.json @@ -42,11 +42,7 @@ "prettier": "npx prettier --ignore-path .gitignore", "test": "npx ls-engines" }, - "prettier": { - "semi": false, - "singleQuote": true, - "trailingComma": "none" - }, + "prettier": "@sanity/prettier-config", "dependencies": { "@semantic-release/changelog": "^6.0.3", "@semantic-release/exec": "^6.0.3", @@ -55,13 +51,13 @@ "semantic-release-license": "^1.0.3" }, "devDependencies": { + "@sanity/prettier-config": "^1.0.2", "ls-engines": "0.9.1", "prettier": "^3.3.1", - "prettier-plugin-packagejson": "^2.5.0", "semantic-release": "^24.0.0" }, "peerDependencies": { - "semantic-release": "^22.0.12 || ^23.0.2 || ^24.0.0" + "semantic-release": "^24" }, "engines": { "node": ">= 20.8"