ci: use reusable workflows (#337)

* ci: use reusable workflows * ci: mark prNumber as not required * ci(cd): mark inputs as string types * ci: update labelsync and publish
sapphiredev · Aug 17, 2024 · d692982 · d692982
1 parent feb4e53
commit d692982
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 217 deletions.
diff --git a/.github/problemMatchers/eslint.json b/.github/problemMatchers/eslint.json
diff --git a/.github/problemMatchers/tsc.json b/.github/problemMatchers/tsc.json
diff --git a/.github/workflows/auto-deprecate.yml b/.github/workflows/auto-deprecate.yml
@@ -7,19 +7,8 @@ on:
 jobs:
   auto-deprecate:
     name: NPM Auto Deprecate
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Project
-        uses: actions/checkout@v4
-      - name: Use Node.js v20
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: yarn
-          registry-url: https://registry.npmjs.org/
-      - name: Install Dependencies
-        run: yarn --immutable
-      - name: Deprecate versions
-        run: yarn npm-deprecate
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+    uses: sapphiredev/.github/.github/workflows/reusable-yarn-job.yml@main
+    with:
+      script-name: npm-deprecate
+    secrets:
+      NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -1,4 +1,4 @@
-name: Code Scanning
+name: Code scanning
 
 on:
   push:
@@ -11,18 +11,6 @@ on:
     - cron: '30 1 * * 0'
 
 jobs:
-  CodeQL:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
-
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
+  codeql:
+    name: Analysis
+    uses: sapphiredev/.github/.github/workflows/reusable-codeql.yml@main
diff --git a/.github/workflows/continuous-delivery.yml b/.github/workflows/continuous-delivery.yml
@@ -5,51 +5,29 @@ on:
     inputs:
       prNumber:
         description: The number of the PR that is being deployed
-        required: true
+        required: false
+        type: string
       ref:
         description: The branch that is being deployed. Should be a branch on the given repository
         required: false
         default: main
+        type: string
       repository:
         description: The {owner}/{repository} that is being deployed.
         required: false
         default: sapphiredev/cli
+        type: string
   push:
     branches:
       - main
 
 jobs:
   Publish:
     name: Publish Next to npm
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Project
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          repository: ${{ github.event.inputs.repository || 'sapphiredev/cli' }}
-          ref: ${{ github.event.inputs.ref || 'main' }}
-      - name: Add TypeScript problem matcher
-        run: echo "::add-matcher::.github/problemMatchers/tsc.json"
-      - 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: Bump Version & Publish
-        run: |
-          # Resolve the tag to be used. "next" for push events, "pr-{prNumber}" for dispatch events.
-          TAG=$([[ ${{ github.event_name }} == 'push' ]] && echo 'next' || echo 'pr-${{ github.event.inputs.prNumber }}')
-
-          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)" --skip-changelog
-
-          yarn npm publish --tag ${TAG}
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    uses: sapphiredev/.github/.github/workflows/reusable-continuous-delivery.yml@main
+    with:
+      pr-number: ${{ github.event.inputs.prNumber }}
+      ref: ${{ github.event.inputs.ref }}
+      repository: ${{ github.event.inputs.repository }}
+    secrets:
+      NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -1,4 +1,4 @@
-name: Continuous Integration
+name: CI
 
 on:
   push:
@@ -7,40 +7,17 @@ on:
   pull_request:
 
 jobs:
-  Linting:
+  linting:
     name: Linting
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Project
-        uses: actions/checkout@v4
-      - name: Add problem matcher
-        run: echo "::add-matcher::.github/problemMatchers/eslint.json"
-      - name: Use Node.js v20
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: yarn
-          registry-url: https://registry.npmjs.org/
-      - name: Install Dependencies
-        run: yarn --immutable
-      - name: Run ESLint
-        run: yarn lint --fix=false
+    uses: sapphiredev/.github/.github/workflows/reusable-lint.yml@main
 
-  Building:
-    name: Compile source code
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Project
-        uses: actions/checkout@v4
-      - name: Add problem matcher
-        run: echo "::add-matcher::.github/problemMatchers/tsc.json"
-      - name: Use Node.js v20
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: yarn
-          registry-url: https://registry.npmjs.org/
-      - name: Install Dependencies
-        run: yarn --immutable
-      - name: Build Code
-        run: yarn build
+  build:
+    name: Building
+    uses: sapphiredev/.github/.github/workflows/reusable-build.yml@main
+
+  sonar:
+    name: Sonar Analysis
+    uses: sapphiredev/.github/.github/workflows/reusable-sonar.yml@main
+    secrets:
+      SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.github/workflows/labelsync.yml b/.github/workflows/labelsync.yml
@@ -7,17 +7,4 @@ on:
 
 jobs:
   label_sync:
-    name: Automatic Label Synchronization
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Project
-        uses: actions/checkout@v4
-        with:
-          sparse-checkout: .github/labels.yml
-          sparse-checkout-cone-mode: false
-          repository: 'sapphiredev/.github'
-      - name: Run Label Sync
-        uses: crazy-max/ghaction-github-labeler@v5
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          yaml-file: .github/labels.yml
+    uses: sapphiredev/.github/.github/workflows/reusable-labelsync.yml@main
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -6,40 +6,9 @@ on:
 jobs:
   PublishPackage:
     name: Publish @sapphire/cli
-    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 }}
+    uses: sapphiredev/.github/.github/workflows/reusable-publish.yml@main
+    with:
+      project-name: '@sapphire/cli'
+    secrets:
+      NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+      SKYRA_TOKEN: ${{ secrets.SKYRA_TOKEN }}
diff --git a/.github/workflows/release-crosspost.yml b/.github/workflows/release-crosspost.yml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -13,5 +13,9 @@
 		"*.ts.sapphire": "typescript",
 		"*.json.sapphire": "json",
 		"*.yml.sapphire": "yaml"
+	},
+	"sonarlint.connectedMode.project": {
+		"connectionId": "https-sonarqube-sapphirejs-dev",
+		"projectKey": "sapphiredev_cli_3f02e75d-9123-4094-a35c-70aac6350330"
 	}
 }
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -0,0 +1 @@
+sonar.projectKey=sapphiredev_cli_3f02e75d-9123-4094-a35c-70aac6350330
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		sonar.projectKey=sapphiredev_cli_3f02e75d-9123-4094-a35c-70aac6350330