Master

.github/ISSUE_TEMPLATE/1_bug_report.yml

@@ -0,0 +1,101 @@
+name: 🐛 Report a bug
+description: Any errors.
+labels: ["needs triage", "bug"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Before you go any further. Is this really a **🐛 bug**?
+
+        If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/master/README.md),
+        [frequently asked questions](https://github.com/alshedivat/al-folio/blob/master/FAQ.md),
+        [past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
+        or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
+
+  - type: checkboxes
+    id: requirements
+    attributes:
+      label: Have you checked that your issue isn't already filed?
+      description: >
+        Please check if somebody else has already filed the same issue.
+        If you find a similar issue, please add a 👍 reaction or comment on the original post.
+      options:
+        - label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/master/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue.
+          required: true
+        - label: Yes, I have checked that this issue isn't already filed.
+          required: true
+
+  - type: input
+    attributes:
+      label: Bug description
+      description: A description of the 🐛 bug.
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How to reproduce the bug
+      description: Provide steps to reproduce the 🐛 bug.
+      placeholder: |
+        Include steps to reproduce, the expected behaviour, and the actual behaviour.
+
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Error messages and logs
+      description: >
+        Provide any error messages and/or logs
+      placeholder: "Copy the complete error messages and logs"
+      value: |
+        ```
+        The error message you got, with the full traceback if available. Please paste it between these triple backticks.
+        ```
+    validations:
+      required: false
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: What operating system are you using?
+      description: select all OSs where you have experienced this issue
+      multiple: true
+      options:
+        - Linux
+        - Mac
+        - Windows
+        - Not applicable (e.g. you're using GitHub Pages or other hosting)
+    validations:
+      required: true
+
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Where are you seeing the problem on?
+      description: select all environments where you have experienced this issue
+      multiple: true
+      options:
+        - "Running locally with Docker"
+        - "Running locally without Docker"
+        - "Deployed site"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: More info
+      description: Add any other info about the issue here.
+      placeholder: |
+        Add any other context about the problem here, such as versions of the libraries if running without docker, screenshots, links to the deployed site, etc.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: "**Happy coding!**"

.github/ISSUE_TEMPLATE/2_feature_request.yml

@@ -0,0 +1,56 @@
+name: 🚀 Feature request
+description: Propose a feature for this project
+labels: ["needs triage", "enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Before you go any further, are you sure that this feature is not already implemented?
+
+        If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/master/README.md),
+        [frequently asked questions](https://github.com/alshedivat/al-folio/blob/master/FAQ.md),
+        [past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
+        or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
+
+  - type: checkboxes
+    id: requirements
+    attributes:
+      label: Have you checked that your feature request isn't already filed?
+      description: >
+        Please check if somebody else has already filed the same 🚀 feature request.
+        If you find a similar feature request, please add a 👍 reaction or comment on the original post.
+      options:
+        - label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/master/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request.
+          required: true
+        - label: Yes, I have checked that this feature request isn't already filed.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Description & Motivation
+      description: A clear and concise description of the 🚀 feature proposal
+      placeholder: |
+        Please outline the motivation for the proposal.
+        Is your feature request related to a problem? e.g., I'm always frustrated when [...].
+        If this is related to another GitHub issue, please link it here
+
+  - type: textarea
+    attributes:
+      label: Pitch
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: A clear and concise description of any alternative solutions or features you've considered, if any.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ❓ Ask a Question
+    url: https://github.com/alshedivat/al-folio/discussions/categories/q-a
+    about: Ask and answer al-folio related questions.
+  - name: 📖 Read the documentation
+    url: https://github.com/alshedivat/al-folio/blob/master/README.md
+    about: Please consult the documentation before opening any issues!

.github/workflows/axe.yml

@@ -16,9 +16,6 @@ on:
         description: "URL to be checked (e.g.: blog/)"
         required: false
 
-permissions:
-  contents: write
-
 env:
   URL: ""
 
@@ -28,14 +25,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.2.2"
           bundler-cache: true
       - name: Update _config.yml ⚙️
-        uses: fjogeleit/yaml-update-action@v0.13.1
+        uses: fjogeleit/yaml-update-action@main
         with:
           commitChange: false
           valueFile: "_config.yml"
@@ -47,15 +44,30 @@ jobs:
       - name: Install and Build 🔧
         run: |
           pip3 install --upgrade jupyter
-          npm install -g mermaid.cli
-          npm install -g purgecss
           export JEKYLL_ENV=production
           bundle exec jekyll build --lsi
+      - name: Purge unused CSS 🧹
+        run: |
+          npm install -g purgecss
           purgecss -c purgecss.config.js
+      - name: Get Chromium version 🌐
+        # https://github.com/GoogleChromeLabs/chrome-for-testing?tab=readme-ov-file#other-api-endpoints
+        run: |
+          CHROMIUM_VERSION=$(wget -qO- https://googlechromelabs.github.io/chrome-for-testing/LATEST_RELEASE_STABLE | cut -d. -f1)
+          echo "Chromium version: $CHROMIUM_VERSION"
+          echo "CHROMIUM_VERSION=$CHROMIUM_VERSION" >> $GITHUB_ENV
+      - name: Setup Chrome 🌐
+        id: setup-chrome
+        uses: browser-actions/setup-chrome@v1
+        with:
+          chrome-version: ${{ env.CHROMIUM_VERSION }}
+      - name: Install chromedriver 🚗
+        run: |
+          npm install -g chromedriver@$CHROMIUM_VERSION
       - name: Run axe 🪓
         # https://github.com/dequelabs/axe-core-npm/tree/develop/packages/cli
         run: |
           npm install -g @axe-core/cli
           npm install -g http-server
           http-server _site/ &
-          axe http://localhost:8080/${{ github.event.inputs.url || env.URL }} --load-delay=1500 --exit
+          axe --chromedriver-path $(npm root -g)/chromedriver/bin/chromedriver http://localhost:8080/${{ github.event.inputs.url || env.URL }} --load-delay=1500 --exit

.github/workflows/broken-links-site.yml

@@ -1,33 +1,26 @@
 name: Check for broken links on site
 
 on:
-  push:
-    branches:
-      - master
-      - main
-  pull_request:
-    branches:
-      - master
-      - main
-  workflow_dispatch:
-
-permissions:
-  contents: write
+  workflow_run:
+    workflows: [Deploy site]
+    types: [completed]
 
 jobs:
-  deploy:
+  check-links-on-site:
+    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#running-a-workflow-based-on-the-conclusion-of-another-workflow
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     # available images: https://github.com/actions/runner-images#available-images
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.2.2"
           bundler-cache: true
       - name: Update _config.yml ⚙️
-        uses: fjogeleit/yaml-update-action@v0.13.1
+        uses: fjogeleit/yaml-update-action@main
         with:
           commitChange: false
           valueFile: "_config.yml"
@@ -39,10 +32,11 @@ jobs:
       - name: Install and Build 🔧
         run: |
           pip3 install --upgrade jupyter
-          npm install -g mermaid.cli
-          npm install -g purgecss
           export JEKYLL_ENV=production
           bundle exec jekyll build --lsi
+      - name: Purge unused CSS 🧹
+        run: |
+          npm install -g purgecss
           purgecss -c purgecss.config.js
       - name: Link Checker 🔗
         uses: lycheeverse/lychee-action@v1.9.0

.github/workflows/broken-links.yml

@@ -2,13 +2,47 @@ name: Check for broken links
 
 on:
   push:
+    branches:
+      - master
+      - main
+    paths:
+      - "assets/**"
+      - "**.html"
+      - "**.js"
+      - "**.liquid"
+      - "**/*.md"
+      - "**.yml"
+      - "!.github/workflows/axe.yml"
+      - "!.github/workflows/deploy-docker-tag.yml"
+      - "!.github/workflows/deploy-image.yml"
+      - "!.github/workflows/docker-slim.yml"
+      - "!.github/workflows/lighthouse-badger.yml"
+      - "!.github/workflows/prettier.yml"
+      - "!lighthouse_results/**"
   pull_request:
+    branches:
+      - master
+      - main
+    paths:
+      - "assets/**"
+      - "**.html"
+      - "**.js"
+      - "**.liquid"
+      - "**/*.md"
+      - "**.yml"
+      - "!.github/workflows/axe.yml"
+      - "!.github/workflows/deploy-docker-tag.yml"
+      - "!.github/workflows/deploy-image.yml"
+      - "!.github/workflows/docker-slim.yml"
+      - "!.github/workflows/lighthouse-badger.yml"
+      - "!.github/workflows/prettier.yml"
+      - "!lighthouse_results/**"
 
 jobs:
   link-checker:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Link Checker 🔗
         uses: lycheeverse/lychee-action@v1.9.0