Bugfix/upload cv (#28)

c3n21 · web-flow · commit 8e6c9019dd06 · 2025-07-13T11:44:01.000+02:00
This pull request introduces significant updates to the GitHub Actions workflows for deployment and release automation, along with minor documentation and content changes. The most notable changes include restructuring the deployment pipeline, adding a new workflow for automated releases, and updating relevant documentation to reflect these changes.

### Workflow Restructuring and Automation:

* [`.github/workflows/deploy.yml`](diffhunk://#diff-28802fbf11c83a2eee09623fb192785e7ca92a3f40602a517c011b947a1822d3L1-L26): Refactored the deployment workflow to separate concerns into distinct jobs (`build-web`, `build-cv`, `deploy-web`, and `deploy-cv`). Added conditional triggers for `push` events on `main` and `release` events to streamline deployment processes. Introduced a new `Upload Pages Artifact` and `Upload CV Artifact` step for better artifact management. [[1]](diffhunk://#diff-28802fbf11c83a2eee09623fb192785e7ca92a3f40602a517c011b947a1822d3L1-L26) [[2]](diffhunk://#diff-28802fbf11c83a2eee09623fb192785e7ca92a3f40602a517c011b947a1822d3R36-R60) [[3]](diffhunk://#diff-28802fbf11c83a2eee09623fb192785e7ca92a3f40602a517c011b947a1822d3L69-R100) [[4]](diffhunk://#diff-28802fbf11c83a2eee09623fb192785e7ca92a3f40602a517c011b947a1822d3L89-R112)

* [`.github/workflows/release.yml`](diffhunk://#diff-87db21a973eed4fef5f32b267aa60fcee5cbdf03c67fafdc2a9b553bb0b15f34R1-R49): Added a new workflow to automatically create a GitHub release when a version bump is detected in `package.json`. This includes validating that only `package.json` was modified, extracting the version, and creating a release tag.

### Documentation Updates:

* [`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L1-R8): Updated the README to explain the new deployment workflow, including the steps required to trigger the deploy pipeline by creating a version bump pull request.

### Content Removal:

* [`src/assets/md/about.md`](diffhunk://#diff-115e3491a2ebce52fe6e5f73d5b2617d3e3f40699c7a03a426879cf24ea0fc89L1-L12): Removed the "About Me" section content, potentially for a redesign or replacement.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -1,29 +1,27 @@
-name: Deploy to GitHub Pages
+name: Build and Deploy
 
 on:
-  # Allows you to run this workflow manually from the Actions tab on GitHub.
+  push:
+    branches:
+      - main
+  release:
+    types: [created]
   workflow_dispatch:
 
-# Allow this job to clone the repo and create a page deployment
 permissions:
   contents: write
   pages: write
   id-token: write
 
 jobs:
-  prepare:
+  build-web:
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/heads/main') || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
     outputs:
-      pnpm-cache-key: ${{ steps.export-cache-key.outputs.key }}
       neovim-lines: ${{ steps.lines.outputs.count }}
     steps:
       - uses: actions/checkout@v4
 
-      # just a workaround to not duplicate the same steps
-      - uses: ./.github/actions/build-with-cv
-        with:
-          cv: ${{ secrets.CV }}
-
       - name: Checkout NeoVim config
         uses: actions/checkout@v4
         with:
@@ -35,14 +33,31 @@ jobs:
         run: |
           COUNT=$(find . -path './.git*' -prune -o -type f -exec wc -l {} \; | awk '{sum+=$1} END {print sum}')
           echo "count=$COUNT" >> "$GITHUB_OUTPUT"
+          echo "NEOVIM_CONFIG_LINES=$COUNT" >> "$GITHUB_ENV"
         working-directory: './neovim_config'
 
+      - name: Set CV_LOCATION environment variable
+        run: |
+          TAG_NAME=${GITHUB_REF_NAME#refs/tags/}
+          PDF_URL="https://github.com/${GITHUB_REPOSITORY}/releases/download/${TAG_NAME}/cv.pdf"
+          echo "CV_LOCATION=$PDF_URL" >> $GITHUB_ENV
+
+      - uses: ./.github/actions/build-with-cv
+        with:
+          cv: ${{ secrets.CV }}
+
+      - name: Upload Pages Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist/
+
   build-cv:
-    needs: prepare
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/heads/main') || github.event_name == 'workflow_dispatch'
+    needs: build-web
     runs-on: ubuntu-latest
     env:
       GITHUB_RUN_NUMBER: ${{ github.run_number }}
-      NEOVIM_CONFIG_LINES: ${{ needs.prepare.outputs.neovim-lines }}
+      NEOVIM_CONFIG_LINES: ${{ needs.build-web.outputs.neovim-lines }}
     steps:
       - uses: actions/checkout@v4
 
@@ -66,16 +81,23 @@ jobs:
         run: |
           pnpm run export-pdf
 
-      - name: Create GitHub Release (if not exists)
-        id: create_release
-        uses: softprops/action-gh-release@v2
+      - name: Upload CV Artifact
+        uses: actions/upload-artifact@v4
         with:
-          tag_name: ${{ github.ref_name }}
-          name: Release ${{ github.ref_name }}
-          draft: false
-          prerelease: false
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          path: ./cv.pdf
+
+  deploy-cv:
+    if: github.event_name == 'release' && github.event.action == 'created' || github.event_name == 'workflow_dispatch'
+    needs: build-cv
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_RUN_NUMBER: ${{ github.run_number }}
+      NEOVIM_CONFIG_LINES: ${{ needs.build-web.outputs.neovim-lines }}
+    steps:
+      - name: Download CV Artifact
+        uses: actions/download-artifact@v4
+        with:
+          path: ./cv.pdf
 
       - name: Upload PDF as Release Asset
         uses: softprops/action-gh-release@v2
@@ -86,38 +108,8 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-  build-web:
-    needs: prepare
-    runs-on: ubuntu-latest
-    env:
-      GITHUB_RUN_NUMBER: ${{ github.run_number }}
-      NEOVIM_CONFIG_LINES: ${{ needs.prepare.outputs.neovim-lines }}
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/cache@v4
-        with:
-          path: ~/.local/share/pnpm/store/v3
-          key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: ${{ runner.os }}-pnpm-
-
-      - name: Set CV_LOCATION environment variable
-        run: |
-          TAG_NAME=${GITHUB_REF_NAME#refs/tags/}
-          PDF_URL="https://github.com/${GITHUB_REPOSITORY}/releases/download/${TAG_NAME}/cv.pdf"
-          echo "CV_LOCATION=$PDF_URL" >> $GITHUB_ENV
-
-      - uses: ./.github/actions/build-with-cv
-        with:
-          cv: ${{ secrets.CV }}
-
-
-      - name: Upload Pages Artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: ./dist/
-
-  deploy:
+  deploy-web:
+    if: github.event_name == 'release' && github.event.action == 'created' || github.event_name == 'workflow_dispatch'
     needs: build-web
     runs-on: ubuntu-latest
     environment:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,49 @@
+name: Auto Release on Version Bump
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    if: contains(github.event.head_commit.message, 'Bump website version')
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Get modified files in last commit
+        id: files
+        run: |
+          echo "files=$(git diff-tree --no-commit-id --name-only -r ${{ github.sha }})" >> $GITHUB_OUTPUT
+
+      - name: Check if only package.json was modified
+        id: check_files
+        run: |
+          files="${{ steps.files.outputs.files }}"
+          # Only package.json allowed
+          if [ "$files" != "package.json" ]; then
+            echo "Only package.json modification allowed, exiting."
+            exit 1
+          fi
+          echo "Only package.json modified."
+
+      - name: Read version from package.json
+        id: get_version
+        run: |
+          version=$(jq -r '.version' package.json)
+          echo "version=$version" >> $GITHUB_OUTPUT
+
+      - name: Create release tag and GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: "v${{ steps.get_version.outputs.version }}"
+          name: "Release v${{ steps.get_version.outputs.version }}"
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
-#TODO
-- [ ] Implement contact me page
-- [ ] Remove tailwindcss-animate
-- [ ] Use oklch instead of hsl
-- [ ] Solve TODOs in codebase
-- [ ] Interpret • as special character and render strings containing it as `li`
-- [ ] Put my big ass face in this website
+# How does deployment work?
+Every time there is push on `main` it will trigger the build pipeline and cache
+the artifacts.
+
+To actually do the deploy of the website and CV in release artifacts the following must be carried out:
+
+1. Create a PR which only bumps the version named "Bump website version"
+2. By merging the PR it will trigger the deploy pipeline
diff --git a/src/assets/md/about.md b/src/assets/md/about.md
diff --git a/tsconfig.json b/tsconfig.json
@@ -12,7 +12,8 @@
                 "name": "@astrojs/ts-plugin"
             }
         ],
-        "types": ["vitest/globals"]
+        "types": ["vitest/globals"],
+        "resolveJsonModule": true
     },
     "exclude": ["dist"],
     "extends": "astro/tsconfigs/strictest",
