Merge branch 'gh-pages' into gh-pages

Author: JohananOppongAmoateng

.github/ISSUE_TEMPLATE/add_conference.yml

@@ -1,7 +1,7 @@
 name: Add Conference
 description: Add Conference dates, location, speaking and other information that you would like shared
 title: "[CONFERENCE] <CONFERENCE NAME> YYYY"
-labels: ["conference"]
+labels: ["conference", "CFP"]
 body:
   - type: input
     id: conference_name
@@ -40,6 +40,22 @@ body:
       placeholder: "CITY, <REGION>, COUNTRY"
     validations:
       required: false
+  - type: input
+    id: cfp_link
+    attributes:
+      label: CFP Link
+      description: Provide the URL for the Call for Proposals (CFP) (make sure to include `https://`).
+      placeholder: "https://example.com/cfp"
+    validations:
+      required: true
+  - type: input
+    id: cfp_deadline
+    attributes:
+      label: CFP Deadline
+      description: Enter the deadline for submitting CFPs (YYYY-MM-DD).
+      placeholder: "YYYY-MM-DD"
+    validations:
+      required: true
   - type: textarea
     id: conference_description
     attributes:

.github/workflows/generate_screenshots.yml

@@ -0,0 +1,41 @@
+name: Generate and Upload Screenshots
+# https://devblogs.microsoft.com/python/announcing-playwright-for-python-reliable-end-to-end-testing-for-the-web/
+# https://github.com/marketplace/actions/run-playwright-tests
+
+on:
+  pull_request:
+    types: [labeled]
+    branches:
+      - gh-pages
+
+  workflow_dispatch:
+
+jobs:
+  test:
+    if: ${{ github.event.label.name == 'design_change' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+          python -m playwright install --with-deps chromium
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          # Run tests
+      - name: Run Tests
+        run: |
+          python -m pytest -m design
+      - name: upload images
+        uses: actions/upload-artifact@v4
+        with:
+          name: page_screenshots
+          path: test_images/
+          compression-level: 9

.github/workflows/playwright.yml

@@ -13,31 +13,24 @@ on:
 
 jobs:
   test:
+    timeout-minutes: 30
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
+          python-version: "3.12"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt
-          python -m playwright install --with-deps
+          python -m playwright install --with-deps chromium
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-      - name: Jekyll detached and pytest
-        run: |
-          # Start up local copy of site
-          bundle exec jekyll serve --detach
-
-          # Sleep for 5 secs to allow Jekyll to start
-          startup_wait=5
-          echo "Sleeping for $startup_wait seconds"
-          sleep $startup_wait
-
           # Run tests
+      - name: Run Tests
+        run: |
           python -m pytest

.github/workflows/scorecard.yml

@@ -0,0 +1,73 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '22 15 * * 4'
+  push:
+    branches: [ "gh-pages" ]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@97a0fba1372883ab732affbe8f94b823f91727db # v3.pre.node20
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard (optional).
+      # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: results.sarif

.gitignore

@@ -15,3 +15,5 @@ _site/
 .bundle/
 vendor/
 2
+test_images
+*-version

.ruby-version

@@ -1 +1 @@
-3.2.2
+3.3.4

CONTRIBUTING.md

@@ -38,6 +38,7 @@ Follow these steps and note these guidelines to begin contributing:
 
 ## Working on an issue
 
+- Please create a separate branch for each issue you work on. Avoid working on multiple issues from the same branch, as this can complicate the review process
 - The easiest way to make changes and and test them is by using [![GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/BlackPythonDevs/blackpythondevs.github.io)
 
 - You can also access the Codespaces from the repository main page:
@@ -58,7 +59,15 @@ Follow these steps and note these guidelines to begin contributing:
 
   ![Bundle install terminal](/assets/images/bundle_install_terminal.png)
 
-- After installing the dependencies, its time to run the application. We do this by running the command `bundle exec jekyll serve` or run the default **Build Task** <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>:
+- Afterwards, run the command `pip install -r requirements-dev.txt` to install the python dev dependencies.
+
+  ![Pip install terminal](/assets/images/pip_install_terminal.png)
+
+- Install the pre-commit hooks to automatically format the code before committing. Run the command `pre-commit install`:
+
+  ![Pre-commit install terminal](/assets/images/pre-commit_install_terminal.png)
+
+- After installing the dependencies, its time to run the application. We do this by running the command `bundle exec jekyll serve --detach` or run the default **Build Task** <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>:
 
   ![Jekyll serve terminal](/assets/images/jekyll_serve_terminal.png)
 
@@ -70,6 +79,32 @@ Follow these steps and note these guidelines to begin contributing:
 
   ![Running page](/assets/images/running_page.png)
 
-- Test your changes (create new tests as needed)
+### Testing Changes (create new tests as needed)
+
+- To run the test suites for the codebase
+
+  - Ensure the site is running locally with `bundle exec jekyll serve --detach`. This will run the server in the background, and any content changes will immediately reflect on the site.
+
+    ![Jekyll serve terminal](/assets/images/jekyll_serve_terminal.png)
+
+    - If you need to restart the server, you can run `pkill -f jekyll` to stop the server and then run `bundle exec jekyll serve --detach` to start the server again.
+
+  - Run all tests in the test-suite with the command `python3 -m pytest`:
+
+    ![Pytest terminal](/assets/images/pytest_run_terminal.png)
+
+### Pushing Changes
+
+- Run `pre-commit run --all` to ensure your code is formatted and linted correctly before pushing your changes.
+
+  ![Pre-commit run terminal](/assets/images/pre-commit_run_terminal.png)
+
+- Run `git commit -m "<Your commit message>"` to commit your changes.
+
+  ![Git commit terminal](/assets/images/git_commit_terminal.png)
+
+- Finally run `git push origin <your-branch-name>` to push your changes to your fork.
+
+  ![Git push terminal](/assets/images/git_push_terminal.png)
 
 - Once you’ve committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button. Please ensure that you compare your feature branch to the desired branch of the repo you are supposed to make a PR to. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes in your development branch and update it. 🥳