feat: update cv v11.0.0 (#54)

* build: add .npmrc file to .gitignore * ci: add pull request template * ci: change lint build and test workflow * ci: update release workflow * build(webpack): update webpack to work with node 18+ * docs: update contributing guide * docs: add mit license to package.json * ci: update deploy to use new github actions for deployment to github pages * build: update husky and eslint * refactor: remove unused testing * refactor: change favicon and update title * refactor: update x profile * feat: update cv to v11.0.0 * chore: squash
kieranroneill · Oct 20, 2023 · fe5b41f · fe5b41f
1 parent df091c7
commit fe5b41f
Show file tree

Hide file tree

Showing 77 changed files with 3,150 additions and 11,470 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -9,7 +9,7 @@ module.exports = {
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:react/recommended',
-    'prettier/@typescript-eslint',
+    'prettier',
   ],
   rules: {
     '@typescript-eslint/no-inferrable-types': 'off',

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,23 @@
+<!--
+The title should summarise what the purpose of this change,
+
+⚠️**NOTE:** The title must conform to the conventional commit message format outlined in CONTRIBUTING.md document, at the root of the project. This is to ensure the merge commit to the main branch is picked up by the CI and creates an entry in the CHANGELOG.md.
+-->
+
+# Description
+<!-- Describe your changes in detail -->
+
+# Type of change
+<!-- What type of change does this change introduce? Put an 'x' in all the boxes that apply. -->
+
+- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] 🏗️ Build configuration (CI configuration, scaffolding etc.)
+- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
+- [ ] 📝 Documentation update(s)
+- [ ] 📦 Dependency update(s)
+- [ ] 👩🏽‍💻 Improve developer experience
+- [ ] ⚡ Improve performance
+- [ ] ✨ New feature (non-breaking change which adds functionality)
+- [ ] ♻ Refactor
+- [ ] ⏪ Revert changes
+- [ ] 🧪 New tests or updates to existing tests
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,35 @@
+name: Deploy
+
+on:
+  release:
+    types: [released] # triggered on main branch releases
+
+jobs:
+  deploy:
+    name: "Deploy"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v3
+      - name: "🔧 Setup"
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn
+      - name: "📝 Create .npmrc"
+        run: |
+          echo "//npm.pkg.github.com/:_authToken=${{ secrets.READ_PACKAGES_TOKEN }}" >> .npmrc
+          echo "@kieranroneill:registry=https://npm.pkg.github.com" >> .npmrc
+      - name: "📦 Install"
+        run: yarn install --frozen-lockfile
+      - name: "🏗️ Build"
+        run: yarn build
+      - name: "🚀 Deploy"
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          cname: kieranoneill.com
+          personal_token: ${{ secrets.READ_AND_WRITE_REPOS_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./dist
+          user_name: kieranroneill
+          user_email: [email protected]
diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml
diff --git a/.github/workflows/lint_and_test.yml b/.github/workflows/lint_and_test.yml
diff --git a/.github/workflows/lint_build_test.yml b/.github/workflows/lint_build_test.yml
@@ -0,0 +1,31 @@
+name: Pull Request Checks
+
+on:
+  pull_request:
+
+jobs:
+  lint_build_test:
+    name: "Lint, Build & Test"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v3
+      - name: "🔧 Setup"
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn
+      - name: "📝 Create .npmrc"
+        run: |
+          echo "//npm.pkg.github.com/:_authToken=${{ secrets.READ_PACKAGES_TOKEN }}" >> .npmrc
+          echo "@kieranroneill:registry=https://npm.pkg.github.com" >> .npmrc
+      - name: "📦 Install"
+        run: yarn install --frozen-lockfile
+      - name: "👕 Lint"
+        run: yarn lint
+      - name: "🏗️ Build"
+        run: yarn build
+      - name: "🧪 Test"
+        run: yarn test
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -7,26 +7,25 @@ on:
 
 jobs:
   release:
+    name: "Release"
     runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [ '14.15.1' ]
-
     steps:
-      - name: "Checkout 🛎️"
-        uses: actions/checkout@v2
-      - name: "Setup Node.js ${{ matrix.node-version }} 🔧"
-        uses: actions/setup-node@v1
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v3
+      - name: "🔧 Setup"
+        uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
-          registry-url: https://npm.pkg.github.com/
-          scope: '@kieranroneill'
-      - name: "Install 📦"
-        run: yarn install --frozen-lockfile
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.PAT_PACKAGES }}
-      - name: "Release 🔖"
+          node-version: 18
+          cache: yarn
+      - name: "📦 Install"
+        run: yarn global add semantic-release @semantic-release/commit-analyzer @semantic-release/release-notes-generator @semantic-release/npm @semantic-release/github @semantic-release/git @semantic-release/changelog
+      - name: "🔖 Release"
         env:
-          GITHUB_TOKEN: ${{ secrets.PAT_RELEASE }}
-        run: npx semantic-release
+          # appears on the release commits
+          GIT_AUTHOR_NAME: kieranroneill
+          GIT_AUTHOR_EMAIL: [email protected]
+          GIT_COMMITTER_NAME: kieranroneill
+          GIT_COMMITTER_EMAIL: [email protected]
+          # used to push the release commit and create the tags
+          GITHUB_TOKEN: ${{ secrets.READ_AND_WRITE_REPOS_TOKEN }}
+        run: semantic-release
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
-# Created by .ignore support plugin (hsz.mobi)
 ### macOS template
 # General
 .DS_Store
@@ -27,6 +26,58 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
+### Windows template
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### VisualStudioCode template
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+### Linux template
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
 ### Node template
 # Logs
 logs
@@ -100,14 +151,14 @@ web_modules/
 
 # dotenv environment variables file
 .env
-.env.test
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
 .parcel-cache
 
 # Next.js build output
 .next
+out
 
 # Nuxt.js build / generate output
 .nuxt
@@ -138,38 +189,12 @@ dist
 .vscode-test
 
 # yarn v2
-
 .yarn/cache
 .yarn/unplugged
 .yarn/build-state.yml
+.yarn/install-state.gz
 .pnp.*
 
-### Windows template
-# Windows thumbnail cache files
-Thumbs.db
-Thumbs.db:encryptable
-ehthumbs.db
-ehthumbs_vista.db
-
-# Dump file
-*.stackdump
-
-# Folder config file
-[Dd]esktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msix
-*.msm
-*.msp
-
-# Windows shortcuts
-*.lnk
-
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
@@ -243,20 +268,9 @@ fabric.properties
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
 
-### Linux template
-*~
-
-# temporary files which can be created if a process still has a handle open of a deleted file
-.fuse_hidden*
-
-# KDE directory preferences
-.directory
-
-# Linux trash folder which might appear on any partition or disk
-.Trash-*
-
-# .nfs files are created when an open file is removed but is still being accessed
-.nfs*
+### Miscellaneous
 
-### Custom
-dist/
+# dependencies
+.npmrc
+/.pnp
+.pnp.js
diff --git a/.huskyrc b/.huskyrc
@@ -0,0 +1,6 @@
+{
+  "hooks": {
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+    "pre-commit": "lint-staged"
+  }
+}
diff --git a/.releaserc b/.releaserc
@@ -8,10 +8,15 @@
     [
       "@semantic-release/git",
       {
-        "assets": ["package.json", "yarn.lock", "CHANGELOG.md"],
+        "assets": ["package.json", "CHANGELOG.md"],
         "message": "chore(release): ${nextRelease.version}\n\n${nextRelease.notes}"
       }
     ],
-    "@semantic-release/github"
+    [
+      "@semantic-release/github",
+      {
+        "releasedLabels": ["🚀 released"]
+      }
+    ]
   ]
 }