Merge branch 'main' into Linter-feature-checking-broken-links-and-show-in-PR

Author: jbampton

.github/workflows/pr-deploy-preview.yml

@@ -0,0 +1,56 @@
+name: Build Pelican site on PR
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Check if pelicanconf.py exists
+        id: check_pelicanconf
+        run: |
+          if [ -f pelicanconf.py ]; then
+            echo "file_exists=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "file_exists=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Install dependencies
+        if: steps.check_pelicanconf.outputs.file_exists == 'true'
+        run: |
+          python -m pip install --upgrade pip
+          pip install pelican markdown
+
+      - name: Build Pelican site
+        if: steps.check_pelicanconf.outputs.file_exists == 'true'
+        run: pelican content -o output -s pelicanconf.py
+
+      - name: Upload artifact (optional)
+        if: steps.check_pelicanconf.outputs.file_exists == 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: pelican-site
+          path: output/
+
+      - name: Deploy to GitHub Pages
+        if: github.event_name == 'pull_request' && steps.check_pelicanconf.outputs.file_exists == 'true'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./output
+          publish_branch: gh-pages-pr-${{ github.event.number }}

.pre-commit-config.yaml

@@ -198,12 +198,12 @@ repos:
         description: Black is the uncompromising Python code formatter. By using it, you agree to cede control over minutiae of hand-formatting. In return, Black gives you speed, determinism, and freedom from pycodestyle nagging about formatting
         language_version: python3
         args: ['--line-length=88']
-  # - repo: https://github.com/PyCQA/bandit
-  #   rev: 1.8.6
-  #   hooks:
-  #     - id: bandit
-  #       name: A security linter from PyCQA
-  #       description: Bandit is a tool designed to find common security issues in Python code
-  #       args: ["-c", "bandit.yaml"]
-  #       files: \.py$
-  #       pass_filenames: false
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.8.6
+    hooks:
+      - id: bandit
+        name: A security linter from PyCQA
+        description: Bandit is a tool designed to find common security issues in Python code
+        args: ['-c', 'bandit.yaml', '-r', '.']
+        files: \.py$
+        pass_filenames: false

.prettierignore

@@ -0,0 +1,2 @@
+package-lock.json
+packages/cfsite/package-lock.json

CONTRIBUTING.md

@@ -112,31 +112,37 @@ Our configuration is already in the repo: [dprint.json](./dprint.json)
 
 #### 🧪 Setting Up pre-commit
 
-Used to enforce newline at end of files and OS-specific line endings.
+We use [pre-commit](https://pre-commit.com/) to automatically check your code for common issues, like missing end-of-file newlines and inconsistent line endings. This keeps our project clean and easy for everyone to work on.
 
-**Install (requires Python):**
+**How to install (requires Python):**
 
 ```bash
-pip install pre-commit
+python -m pip install --user pre-commit
 ```
 
-**Activate pre-commit hooks:**
+**Set up pre-commit hooks for this project:**
 
 ```bash
 pre-commit install
 ```
 
-**Run manually (optional):**
+This will make pre-commit run its checks every time you make a commit.
+**Running checks manually (optional):**
 
 ```bash
 pre-commit run --all-files
 ```
 
+This command runs all configured pre-commit hooks against all files in the repository.
+For more info, visit the [pre-commit website](https://pre-commit.com/).
+
 ---
 
 ### 5. 📝 Commit Changes
 
-Use descriptive commit messages that clearly state the purpose of your changes.
+Use meaningful and clear commit messages that describe the purpose of your changes. This helps maintain a clean and understandable project history.
+
+**Example of staging and committing changes:**
 
 ```bash
 git add .
@@ -145,22 +151,29 @@ git commit -m "Add feature: description of feature"
 
 ### 6. ⬆️ Push Changes
 
+Push your local branch to your remote fork. Replace `your-branch-name` with the name of your current branch.
+
 ```bash
 git push origin add-new-feature
 ```
 
+This makes your changes available for review and merging via a Pull Request.
+
 ### 7. 🔄 Create a Pull Request
 
 - Go to your forked repository on GitHub.
-- Click **"Compare & pull request"**.
-- Add a title and description (e.g., "Fixes #102").
-- Click **"Create pull request"**.
+- Click the **"Compare & pull request"** button near the top of the page.
+- Make sure your changes look correct and you are merging into the right branch.
+- Write a clear and simple title describing your changes.
+- Add a short description explaining what you changed and why. If it fixes an issue, mention it like this: `Fixes #issue-number`.
+- Click **"Create pull request"** to submit your contribution.
+- Watch for feedback on your Pull Request and respond to any comments.
 
 ---
 
 ## Community Support
 
 If you need help or have questions:
 
-- Join Discussions: Participate in discussions.
-- Contact Maintainers: Reach out to project maintainers if needed.
+- Join Discussions: Participate in ongoing discussions with the community.
+- Contact Maintainers: Reach out to project maintainers if you need direct assistance.

Dockerfile

@@ -0,0 +1,31 @@
+FROM node:22.18.0-bullseye
+
+ENV GO_VERSION=1.24.5
+ENV NODE_VERSION=22.18.0
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    curl \
+    git \
+    bash \
+    python3 \
+    python3-pip \
+    build-essential \
+    ca-certificates \
+    tar \
+    xz-utils \
+    libstdc++6 \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN pip3 install pre-commit
+
+RUN curl -LO https://mirrors.aliyun.com/golang/go${GO_VERSION}.linux-amd64.tar.gz && \
+    tar -C /usr/local -xzf go${GO_VERSION}.linux-amd64.tar.gz && \
+    rm go${GO_VERSION}.linux-amd64.tar.gz
+
+ENV PATH="/usr/local/go/bin:${PATH}"
+
+RUN go version && python3 --version && pip3 --version
+
+WORKDIR /app
+
+CMD ["pre-commit", "run", "--all-files"]

README.md

@@ -9,6 +9,8 @@ Welcome to the source code repository for the Brisbane Social Chess website.
 [![CodeQL Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/brisbanesocialchess/brisbanesocialchess.github.io/.github%2Fworkflows%2Fcodeql.yml?label=codeql)](https://github.com/brisbanesocialchess/brisbanesocialchess.github.io/actions/workflows/codeql.yml)
 [![Dprint Workflow Status](https://img.shields.io/github/actions/workflow/status/brisbanesocialchess/brisbanesocialchess.github.io/.github%2Fworkflows%2Fdprint.yml?label=dprint)](https://github.com/brisbanesocialchess/brisbanesocialchess.github.io/actions/workflows/dprint.yml)
 [![Git Clone Matrix Workflow Status](https://img.shields.io/github/actions/workflow/status/brisbanesocialchess/brisbanesocialchess.github.io/.github%2Fworkflows%2Fgit-clone-matrix.yml?label=git-clone-matrix)](https://github.com/brisbanesocialchess/brisbanesocialchess.github.io/actions/workflows/git-clone-matrix.yml)
+[![GitHub License](https://img.shields.io/github/license/brisbanesocialchess/brisbanesocialchess.github.io)](LICENSE)
+[![GitHub Pages](https://img.shields.io/website?url=https%3A%2F%2Fbrisbanesocialchess.github.io&label=github-pages)](https://brisbanesocialchess.github.io)
 [![Labeler Workflow Status](https://img.shields.io/github/actions/workflow/status/brisbanesocialchess/brisbanesocialchess.github.io/.github%2Fworkflows%2Flabeler.yml?label=labeler)](https://github.com/brisbanesocialchess/brisbanesocialchess.github.io/actions/workflows/labeler.yml)
 [![Lerna Workflow Status](https://img.shields.io/github/actions/workflow/status/brisbanesocialchess/brisbanesocialchess.github.io/.github%2Fworkflows%2Flerna.yml?label=lerna)](https://github.com/brisbanesocialchess/brisbanesocialchess.github.io/actions/workflows/lerna.yml)
 [![Ls-lint Workflow Status](https://img.shields.io/github/actions/workflow/status/brisbanesocialchess/brisbanesocialchess.github.io/.github%2Fworkflows%2Fls-lint.yml?label=ls-lint)](https://github.com/brisbanesocialchess/brisbanesocialchess.github.io/actions/workflows/ls-lint.yml)
@@ -28,6 +30,7 @@ Welcome to the source code repository for the Brisbane Social Chess website.
   - [Run Tests](#run-tests)
 - [About Brisbane Social Chess](#about-brisbane-social-chess)
 - [Getting Started / Building the Site](#getting-started--building-the-site)
+- [Build the Docker image for running `pre-commit` easily](#build-the-docker-image-for-running-pre-commit-easily)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -74,4 +77,26 @@ npx serve
 
 ---
 
+## Build the Docker image for running `pre-commit` easily
+
+```bash
+docker build -t my-go-precommit .
+or
+docker build --no-cache -t my-go-precommit .
+```
+
+And then:
+
+```bash
+docker run --rm -v "$PWD":/app -w /app my-go-precommit
+```
+
+Or if you want to run and keep the container and go into bash:
+
+```bash
+docker run -it -v "$PWD":/app -w /app my-go-precommit bash
+```
+
+---
+
 © 2025 Brisbane Social Chess

bandit.yaml

@@ -1 +1,4 @@
+# FILE: bandit.yaml
 exclude_dirs: ['node_modules', 'packages/cfsite/node_modules']
+tests: ['B201', 'B301']
+skips: ['B101', 'B601']

docs/404.html

@@ -13,16 +13,17 @@
     <div class="background-overlay">
       <main class="content-wrapper">
         <div class="logo">
-            <a href="/">
-              <img src="/assets/logo.jpg" alt="Brisbane Social Chess Logo" />
-            </a>
+          <a href="/">
+            <img src="/assets/logo.jpg" alt="Brisbane Social Chess Logo" />
+          </a>
           <h1>Oops! Page Not Found</h1>
           <p>Looks like the page you're looking for doesn't exist.</p>
         </div>
         <nav class="nav-links">
           <a href="/">Home</a>
           <a href="/about.html">About</a>
           <a href="/games.html">Games</a>
+          <a href="/meetup.html">Meetups</a>
           <a href="/minutes.html">Minutes</a>
           <a href="/register.html">Register</a>
           <a href="/rules.html">Rules</a>
@@ -31,26 +32,17 @@ <h1>Oops! Page Not Found</h1>
         </nav>
         <section class="section">
           <h2>Error 404 – Not Found</h2>
-          <p>
-            Don’t worry, you haven’t blundered too badly. Maybe the link is outdated or there's a typo in the URL.
-          </p>
-          <p>
-            You can return to our homepage or explore other sections of our site.
-          </p>
-
+          <p> Don’t worry, you haven’t blundered too badly. Maybe the link is outdated or there's a typo in the URL. </p>
+          <p> You can return to our homepage or explore other sections of our site. </p>
           <div class="button-group">
             <a href="/" class="button">Go Home</a>
           </div>
           <img src="assets/locations.jpg" alt="Chess Pieces Lost" />
         </section>
       </main>
     </div>
-
     <footer class="site-footer">
-      <p>
-        &copy; <span id="year"></span> Brisbane Social Chess. All rights
-        reserved.
-      </p>
+      <p> &copy; <span id="year"></span> Brisbane Social Chess. All rights reserved. </p>
     </footer>
     <script type="text/javascript" src="/script.js"></script>
   </body>