ci: setup cliff-jumper v4 and publishing workflow (#377)

* ci: setup cliff-jumper v4 and publishing workflow * chore: deps * Update continuous-delivery.yml * chore: it's getting hard to keep up with the crap i've trashed
sapphiredev · Jun 23, 2024 · b59ed17 · b59ed17
1 parent 25cd76c
commit b59ed17
Show file tree

Hide file tree

Showing 7 changed files with 6,386 additions and 6,068 deletions.
diff --git a/.cliff-jumperrc.yml b/.cliff-jumperrc.yml
@@ -4,3 +4,8 @@ org: sapphire
 monoRepo: false
 commitMessageTemplate: 'chore(release): release {{new-version}}'
 tagTemplate: v{{new-version}}
+identifierBase: false
+pushTag: true
+githubRelease: true
+githubReleaseLatest: true
+githubRepo: sapphiredev/shapeshift
diff --git a/.github/workflows/continuous-delivery.yml b/.github/workflows/continuous-delivery.yml
@@ -48,8 +48,9 @@ jobs:
           yarn config set npmAuthToken ${NODE_AUTH_TOKEN}
           yarn config set npmPublishRegistry "https://registry.yarnpkg.com"
 
-          yarn bump --preid "${TAG}.$(git rev-parse --verify --short HEAD)"
+          yarn bump --preid "${TAG}.$(git rev-parse --verify --short HEAD)" --skip-changelog
 
           yarn npm publish --tag ${TAG}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,45 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+
+jobs:
+  PublishPackage:
+    name: Publish @sapphire/shapeshift
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'sapphiredev'
+    steps:
+      - name: Checkout Project
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: main
+          token: ${{ secrets.SKYRA_TOKEN }}
+      - name: Use Node.js v20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+          registry-url: https://registry.yarnpkg.com/
+      - name: Install Dependencies
+        run: yarn --immutable
+      - name: Configure Git
+        run: |
+          git remote set-url origin "https://${GITHUB_TOKEN}:x-oauth-basic@github.com/${GITHUB_REPOSITORY}.git"
+          git config --local user.email "${GITHUB_EMAIL}"
+          git config --local user.name "${GITHUB_USER}"
+        env:
+          GITHUB_USER: github-actions[bot]
+          GITHUB_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Bump Versions and make release
+        run: yarn bump
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Publish to NPM
+        run: |
+          yarn config set npmAuthToken ${NODE_AUTH_TOKEN}
+          yarn config set npmPublishRegistry "https://registry.yarnpkg.com"
+          yarn npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,9 +1,4 @@
 {
-	"eslint.validate": ["typescript"],
-	"editor.tabSize": 4,
-	"editor.useTabStops": true,
-	"editor.insertSpaces": false,
-	"editor.detectIndentation": false,
 	"files.eol": "\n",
 	"search.exclude": {
 		"**/node_modules": true,

diff --git a/cliff.toml b/cliff.toml
@@ -5,13 +5,16 @@ header = """
 All notable changes to this project will be documented in this file.\n
 """
 body = """
+{%- macro remote_url() -%}
+  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
+{%- endmacro -%}
 {% if version %}\
     # [{{ version | trim_start_matches(pat="v") }}]\
     {% if previous %}\
         {% if previous.version %}\
-            (https://github.com/sapphiredev/shapeshift/compare/{{ previous.version }}...{{ version }})\
+            ({{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }})\
         {% else %}\
-            (https://github.com/sapphiredev/shapeshift/tree/{{ version }})\
+            ({{ self::remote_url() }}/tree/{{ version }})\
         {% endif %}\
     {% endif %} \
     - ({{ timestamp | date(format="%Y-%m-%d") }})
@@ -24,7 +27,10 @@ body = """
 		- {% if commit.scope %}\
 			**{{commit.scope}}:** \
 		  {% endif %}\
-            {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/sapphiredev/shapeshift/commit/{{ commit.id }}))\
+            {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
+            {% if commit.github.pr_number %} (\
+                [#{{ commit.github.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.github.pr_number }}) by @{{ commit.github.username }}) \
+            {%- endif %}\
 		{% if commit.breaking %}\
 			{% for breakingChange in commit.footers %}\
 				\n{% raw %}  {% endraw %}- 💥 **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\
@@ -40,24 +46,32 @@ footer = ""
 conventional_commits = true
 filter_unconventional = true
 commit_parsers = [
-    { message = "^feat", group = "🚀 Features"},
-    { message = "^fix", group = "🐛 Bug Fixes"},
-    { message = "^docs", group = "📝 Documentation"},
-    { message = "^perf", group = "🏃 Performance"},
-    { message = "^refactor", group = "🏠 Refactor"},
-    { message = "^typings", group = "⌨️ Typings"},
-    { message = "^types", group = "⌨️ Typings"},
-    { message = ".*deprecated", body = ".*deprecated", group = "🚨 Deprecation"},
-    { message = "^revert", skip = true},
-    { message = "^style", group = "🪞 Styling"},
-    { message = "^test", group = "🧪 Testing"},
-    { message = "^chore", skip = true},
-    { message = "^ci", skip = true},
-    { message = "^build", skip = true},
-    { body = ".*security", group = "🛡️ Security"},
+	{ message = "^feat", group = "🚀 Features" },
+	{ message = "^fix", group = "🐛 Bug Fixes" },
+	{ message = "^docs", group = "📝 Documentation" },
+	{ message = "^perf", group = "🏃 Performance" },
+	{ message = "^refactor", group = "🏠 Refactor" },
+	{ message = "^typings", group = "⌨️ Typings" },
+	{ message = "^types", group = "⌨️ Typings" },
+	{ message = ".*deprecated", body = ".*deprecated", group = "🚨 Deprecation" },
+	{ message = "^revert", skip = true },
+	{ message = "^style", group = "🪞 Styling" },
+	{ message = "^test", group = "🧪 Testing" },
+	{ message = "^chore", skip = true },
+	{ message = "^ci", skip = true },
+	{ message = "^build", skip = true },
+	{ body = ".*security", group = "🛡️ Security" },
+]
+commit_preprocessors = [
+	# remove issue numbers from commits
+	{ pattern = '\s\((\w+\s)?#([0-9]+)\)', replace = "" },
 ]
 filter_commits = true
 tag_pattern = "v[0-9]*"
 ignore_tags = ""
 topo_order = false
 sort_commits = "newest"
+
+[remote.github]
+owner = "sapphiredev"
+repo = "shapeshift"
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
 	"devDependencies": {
 		"@commitlint/cli": "^19.3.0",
 		"@commitlint/config-conventional": "^19.2.2",
-		"@favware/cliff-jumper": "^3.0.3",
+		"@favware/cliff-jumper": "^4.0.2",
 		"@favware/npm-deprecate": "^1.0.7",
 		"@sapphire/eslint-config": "^5.0.5",
 		"@sapphire/prettier-config": "^2.0.0",