docs: Add the release notes to the website (#110)

.github/workflows/website.yaml

@@ -0,0 +1,78 @@
+name: website
+
+on:
+  pull_request:
+    branches: [ main ]
+  push:
+    branches: [ main ]
+  schedule:
+    - cron:  '0 9 * * *'
+  workflow_dispatch:
+
+jobs:
+
+  website-build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Checkout required submodules
+      run: |
+        git submodule update --init --depth 1 scripts/build-tools
+        git submodule update --init --depth 1 scripts/changes
+
+    - name: Setup Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.9"
+
+    - name: Install pipenv
+      run: |
+        python -m pip install --upgrade pipenv wheel
+
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18
+
+    - name: Install dependencies
+      run: scripts/install-dependencies.sh
+
+    - name: Build website
+      run: |
+        scripts/build-website.sh
+
+    - name: Fix permissions
+      run: |
+        chmod -v -R +rX "_site/" | while read line; do
+          echo "::warning title=Invalid file permissions automatically fixed::$line"
+        done
+
+    - name: Upload Pages artifact
+      uses: actions/upload-pages-artifact@v2
+
+  website-deploy:
+    needs: website-build
+    if: ${{ github.ref == 'refs/heads/main' }}
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action

.gitignore

@@ -1,7 +1,9 @@
-build
-docs/_site
-docs/.jekyll-cache
-fastlane/.env
-fastlane/report.xml
 .local
-.tool-versions
+.tool-versions
+
+/_site
+/build
+/docs/.jekyll-cache
+/docs/_site
+/docs/release-notes
+/macos/build

.gitmodules

@@ -1,12 +1,12 @@
 [submodule "scripts/changes"]
 	path = scripts/changes
-	url = git@github.com:jbmorley/changes.git
+	url = https://github.com/jbmorley/changes.git
 [submodule "scripts/build-tools"]
 	path = scripts/build-tools
-	url = git@github.com:jbmorley/build-tools.git
+	url = https://github.com/jbmorley/build-tools.git
 [submodule "diligence"]
 	path = diligence
-	url = git@github.com:inseven/diligence.git
+	url = https://github.com/inseven/diligence.git
 [submodule "interact"]
 	path = interact
-	url = git@github.com:inseven/interact.git
+	url = https://github.com/inseven/interact.git

docs/_config.yml

@@ -33,6 +33,7 @@ github_username:  jekyll
 theme: minima
 plugins:
   - jekyll-feed
+destination: ../_site
 
 defaults:
   - values:

docs/_includes/navigation.html

@@ -1,5 +1,6 @@
 <ul class="navigation">
     <li><a href="/">Overview</a></li>
+    <li><a href="/release-notes">Release Notes</a></li>
     <li><a href="/privacy-policy">Privacy Policy</a></li>
     <li><a href="https://github.com/inseven/overview" target="_blank">GitHub</a></li>
 </ul>

scripts/build-website.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+# Copyright (c) 2018-2023 Jason Morley, Tom Sutcliffe
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+set -e
+set -o pipefail
+set -x
+set -u
+
+SCRIPTS_DIRECTORY="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
+ROOT_DIRECTORY="${SCRIPTS_DIRECTORY}/.."
+WEBSITE_DIRECTORY="${ROOT_DIRECTORY}/docs"
+WEBSITE_SIMULATOR_DIRECTORY="${ROOT_DIRECTORY}/docs/simulator"
+SIMULATOR_WEB_DIRECTORY="${ROOT_DIRECTORY}/simulator/web"
+
+RELEASE_NOTES_TEMPLATE_PATH="${SCRIPTS_DIRECTORY}/release-notes.markdown"
+RELEASE_NOTES_DIRECTORY="${ROOT_DIRECTORY}/docs/release-notes"
+RELEASE_NOTES_PATH="${RELEASE_NOTES_DIRECTORY}/index.markdown"
+
+source "${SCRIPTS_DIRECTORY}/environment.sh"
+
+cd "$ROOT_DIRECTORY"
+if [ -d "${RELEASE_NOTES_DIRECTORY}" ]; then
+    rm -r "${RELEASE_NOTES_DIRECTORY}"
+fi
+mkdir -p "${RELEASE_NOTES_DIRECTORY}"
+changes notes --pre-release --all --released --template "$RELEASE_NOTES_TEMPLATE_PATH" > "$RELEASE_NOTES_PATH"
+
+# Install the Jekyll dependencies.
+export GEM_HOME="${ROOT_DIRECTORY}/.local/ruby"
+mkdir -p "$GEM_HOME"
+export PATH="${GEM_HOME}/bin":$PATH
+gem install bundler
+cd "${WEBSITE_DIRECTORY}"
+bundle install
+
+# Build the website.
+cd "${WEBSITE_DIRECTORY}"
+bundle exec jekyll build

scripts/release-notes.markdown

@@ -0,0 +1,15 @@
+---
+title: Release Notes
+---
+
+# Release Notes
+
+{% for release in releases -%}
+## {{ release.version }}{% if not release.is_released %} (Unreleased){% endif %}
+{% for section in release.sections %}
+**{{ section.title }}**
+
+{% for change in section.changes | reverse -%}
+- {{ change.description }}{% if change.scope %}{{ change.scope }}{% endif %}
+{% endfor %}{% endfor %}
+{% endfor %}

scripts/update-release-notes.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+# Copyright (c) 2021-2023 Jason Morley, Tom Sutcliffe
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+set -e
+set -o pipefail
+set -x
+set -u
+
+SCRIPTS_DIRECTORY="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
+ROOT_DIRECTORY="${SCRIPTS_DIRECTORY}/.."
+RELEASE_NOTES_TEMPLATE_PATH="${SCRIPTS_DIRECTORY}/release-notes.markdown"
+RELEASE_NOTES_DIRECTORY="${ROOT_DIRECTORY}/docs/release-notes"
+RELEASE_NOTES_PATH="${RELEASE_NOTES_DIRECTORY}/index.markdown"
+
+source "${SCRIPTS_DIRECTORY}/environment.sh"
+
+
+cd "$ROOT_DIRECTORY"
+
+mkdir -p "$RELEASE_NOTES_DIRECTORY"
+changes notes --all --released --template "$RELEASE_NOTES_TEMPLATE_PATH" > "$RELEASE_NOTES_PATH"