⬆️ Update GitHub Actions workflows and dependencies (#14)

NatoBoram · web-flow · commit 6ecf365b2458 · 2024-01-06T13:50:27.000-05:00
* ⬆️ Update GitHub Actions workflows and dependencies

* 🔧 Add TypeScript ESLint rules

* 🔧 Update .dockerignore, .eslintrc.yaml, and package.json

* ✏️ Update Docker image in GitHub workflow
diff --git a/.dockerignore b/.dockerignore
@@ -1,20 +1,23 @@
+# Folders
+.git
+.github
+.vscode
+dist
+docs
+node_modules
+
+# Files
 .dockerignore
 .editorconfig
 .eslintignore
 .eslintrc.yaml
-.git
-.github
 .gitignore
 .prettierignore
 .prettierrc.yaml
-.vscode
 *.md
 *.test.ts
 *.tsbuildinfo
 *.txt
-dist
 Dockerfile
-docs
-node_modules
 tsconfig.eslint.json
 typedoc.json
diff --git a/.eslintignore b/.eslintignore
@@ -1,3 +1,4 @@
+.pnpm-store/
 dist/
 docs/
 node_modules/
diff --git a/.eslintrc.yaml b/.eslintrc.yaml
@@ -15,7 +15,28 @@ parserOptions:
 plugins:
   - "@typescript-eslint"
 rules:
+  "@typescript-eslint/class-methods-use-this": error
+  "@typescript-eslint/consistent-type-exports": error
   "@typescript-eslint/consistent-type-imports":
     - error
     - fixStyle: separate-type-imports
+  "@typescript-eslint/default-param-last": error
+  "@typescript-eslint/explicit-member-accessibility":
+    - error
+    - accessibility: no-public
+  "@typescript-eslint/method-signature-style": error
+  "@typescript-eslint/no-import-type-side-effects": error
+  "@typescript-eslint/no-unnecessary-qualifier": error
+  "@typescript-eslint/no-useless-empty-export": error
+  "@typescript-eslint/prefer-nullish-coalescing":
+    - error
+    - ignorePrimitives: true
+  "@typescript-eslint/prefer-readonly": error
+  "@typescript-eslint/prefer-regexp-exec": error
+  "@typescript-eslint/promise-function-async":
+    - error
+    - checkArrowFunctions: false
+  "@typescript-eslint/require-array-sort-compare": error
+  "@typescript-eslint/return-await": error
+  "@typescript-eslint/sort-type-constituents": error
   "@typescript-eslint/switch-exhaustiveness-check": error
diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
@@ -0,0 +1,54 @@
+name: Docker
+
+on:
+  push:
+    branches: main
+    tags: v*
+  pull_request:
+    branches: main
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+
+    if: github.actor != 'nektos/act'
+
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: docker/login-action@v3
+        if: github.actor != 'dependabot[bot]'
+        with:
+          username: ${{ vars.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - uses: docker/login-action@v3
+        if: github.actor != 'dependabot[bot]'
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            natoboram/gigachad.ts
+            ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=tag
+            type=semver,pattern={{major}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}.{{minor}}.{{patch}}
+            type=semver,pattern={{version}}
+
+      - uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: ${{ github.ref_type == 'tag' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
diff --git a/.github/workflows/github-pages.yaml b/.github/workflows/github-pages.yaml
@@ -8,18 +8,20 @@ jobs:
   build_pages:
     runs-on: ubuntu-latest
 
+    if: github.actor != 'nektos/act'
+
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v2
         with:
           version: latest
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 21
           cache: pnpm
-      - run: pnpm install --frozen-lockfile
+      - run: pnpm install
       - run: pnpm run docs
-      - uses: actions/upload-pages-artifact@v1
+      - uses: actions/upload-pages-artifact@v3
         with:
           path: docs
 
@@ -37,5 +39,5 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/deploy-pages@v1
-        id: deployment
+      - id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.github/workflows/node.js.yaml b/.github/workflows/node.js.yaml
@@ -11,11 +11,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v2
         with:
           version: latest
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 21
           cache: pnpm
diff --git a/.github/workflows/pnpm-publish.yaml b/.github/workflows/pnpm-publish.yaml
@@ -13,27 +13,29 @@ jobs:
       contents: read
       packages: write
 
+    if: github.actor != 'nektos/act'
+
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v2
         with:
           version: latest
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           cache: pnpm
           node-version: 21
-      - run: pnpm install --frozen-lockfile
+      - run: pnpm install
       - run: pnpm build
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           registry-url: https://npm.pkg.github.com
           scope: "@natoboram"
       - run: pnpm publish --access public --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           registry-url: https://registry.npmjs.org
           scope: "@natoboram"
diff --git a/.github/workflows/pnpm-version-patch.yaml b/.github/workflows/pnpm-version-patch.yaml
@@ -9,14 +9,16 @@ jobs:
     permissions:
       contents: write
 
+    if: github.actor != 'nektos/act' && github.ref_name == 'main'
+
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ssh-key: ${{ secrets.SIGNING_KEY_PRIVATE }}
       - uses: pnpm/action-setup@v2
         with:
           version: latest
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           cache: pnpm
           node-version: 21
@@ -25,14 +27,17 @@ jobs:
           git config user.name 'github-actions[bot]'
           git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
 
+          git config commit.gpgsign true
           git config gpg.format ssh
           git config user.signingkey 'key::${{ vars.SIGNING_KEY_PUBLIC }}'
 
           eval `ssh-agent -s`
           ssh-add - <<< '${{ secrets.SIGNING_KEY_PRIVATE }}'
 
-          VERSION=$(pnpm version patch)
+          VERSION=$(pnpm version patch --no-git-tag-version)
 
+          git commit --all --message "🔖 $VERSION"
+          git tag $VERSION
           git push
           git push --tags
 
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.pnpm-store/
 bun.lockb
 dist/
 docs/
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,4 @@
+.pnpm-store/
 dist/
 docs/
 node_modules/
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@ The most gigachad project setup for TypeScript.
 - Package management with [PNPM](https://github.com/pnpm/pnpm)
 - Publish it with a GitHub Workflow
 - Run it with [`tsx`](https://github.com/privatenumber/tsx)
+- Run your GitHub Actions locally with [`act`](https://github.com/nektos/act)
 - Unit tests with [Vitest](https://github.com/vitest-dev/vitest)
 
 ## Publishing
@@ -30,6 +31,7 @@ To make the `git push` work when signed commits are enforced (because you are a
 1. Genereate a SSH key with <https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key>
 2. Add the private key to your project's secrets at `/settings/secrets/actions/new` with the name `SIGNING_KEY_PRIVATE`
 3. Add the public key to your project's variables at `/settings/variables/actions/new` with the name `SIGNING_KEY_PUBLIC`
+4. Add the public key to your project's deploy keys at `/settings/keys`
 
 To publish on NPM, you'll need to provide your NPM token.
 
diff --git a/package.json b/package.json
@@ -40,12 +40,13 @@
 	"scripts": {
 		"build": "tsc",
 		"dev": "tsx ./src/main.ts",
+		"docker": "pnpm run docker:build && npm run docker:run",
 		"docker:build": "docker build -t gigachad.ts .",
 		"docker:run": "docker run gigachad.ts",
-		"docker": "pnpm run docker:build && npm run docker:run",
 		"docs": "typedoc",
 		"format": "prettier --write .",
 		"lint": "eslint . && prettier --check .",
+		"lint:fix": "eslint --fix .; prettier --list-different --write .",
 		"start": "node dist/main.js",
 		"test": "vitest"
 	},
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1 @@
+export * from "./main.js"

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.pnpm-store/`
`1`	`2`	`dist/`
`2`	`3`	`docs/`
`3`	`4`	`node_modules/`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.pnpm-store/`
`1`	`2`	`bun.lockb`
`2`	`3`	`dist/`
`3`	`4`	`docs/`