17 Commits

Author SHA1 Message Date
changelog-bot
f95635886c docs(changelog): update changelog [skip ci] 2025-12-26 22:15:48 +00:00
4afd4a00f9 Merging of release and changelog workflows to reduce burden on git server load.
All checks were successful
Changelog + Release on main / changelog_and_release (push) Successful in 23s
Signed-off-by: Alexander Davis <alex@adcm.uk>
2025-12-26 22:15:21 +00:00
changelog-bot
0b8cc2a581 docs(changelog): update changelog [skip ci] 2025-12-26 22:01:56 +00:00
c9402db818 1.9.4
All checks were successful
Changelog / changelog (push) Successful in 36s
Release on main / release (push) Successful in 34s
Forgot to change RELEASE_PAT to CHANGELOG_PAT
2025-12-26 22:01:27 +00:00
changelog-bot
9b065f7cce docs(changelog): update changelog [skip ci] 2025-12-26 21:58:38 +00:00
82654d9489 Version 1.9.2
Some checks failed
Changelog / changelog (push) Successful in 29s
Release on main / release (push) Failing after 30s
Fixes to release workflow

Signed-off-by: Alexander Lyall <alexander.lyall@adcm.uk>
2025-12-26 21:58:14 +00:00
changelog-bot
064cf7df4f docs(changelog): update changelog [skip ci] 2025-12-26 21:53:57 +00:00
2ce3407d22 Update .gitea/workflows/release.yaml
Some checks failed
Changelog / changelog (push) Successful in 28s
Release on main / release (push) Failing after 26s
2025-12-26 21:53:37 +00:00
changelog-bot
a0d4b44364 docs(changelog): update changelog [skip ci] 2025-12-26 21:53:00 +00:00
360f01051d Update .gitea/workflows/release.yaml
All checks were successful
Changelog / changelog (push) Successful in 21s
2025-12-26 21:52:43 +00:00
changelog-bot
2d2491f469 docs(changelog): update changelog [skip ci] 2025-12-26 21:48:25 +00:00
862316dc1c Update .gitea/workflows/release.yaml
All checks were successful
Changelog / changelog (push) Successful in 23s
2025-12-26 21:48:07 +00:00
01ae039b17 Merge branch 'main' of https://git.adcmnetworks.co.uk/alexander.lyall/CS-Box.git
* 'main' of https://git.adcmnetworks.co.uk/alexander.lyall/CS-Box.git:
  docs(changelog): update changelog [skip ci]
2025-12-26 21:46:40 +00:00
f93fb4152a V1.9.1
Addition of release workflow

Signed-off-by: Alexander Davis <alex@adcm.uk>
2025-12-26 21:46:32 +00:00
changelog-bot
f306b4c85b docs(changelog): update changelog [skip ci] 2025-12-26 21:38:04 +00:00
e4a8617927 docs(release): v1.9
All checks were successful
Changelog / changelog (push) Successful in 21s
- Add initial CHANGELOG.md (Keep a Changelog format)
- Group historical commits by Conventional Commit type
- Stabilise git-cliff configuration for automated changelog generation
- Fix template issues to support first run with no tags
- Align changelog wording with Computing:Box branding

Signed-off-by: Alexander Lyall <alex@adcm.uk>
2025-12-26 21:37:23 +00:00
e861dd40d9 Signed-off-by: Alexander Davis <alex@adcm.uk>
Some checks failed
Changelog / changelog (push) Failing after 21s
2025-12-26 21:27:49 +00:00
4 changed files with 378 additions and 124 deletions

View File

@@ -1,62 +0,0 @@
name: Changelog
on:
push:
branches: [ main ]
tags:
- "v*"
workflow_dispatch:
jobs:
changelog:
runs-on: ubuntu-latest
steps:
- name: Checkout (full history + tags)
uses: actions/checkout@v4
with:
fetch-depth: 0
# Generates Keep a Changelog style CHANGELOG.md using git-cliff.
# IMPORTANT: The action downloads git-cliff from GitHub Releases, so we pass a GitHub PAT
# (stored as a Gitea secret) to avoid GitHub API 401/rate-limit issues.
- name: Generate CHANGELOG.md (Keep a Changelog)
uses: orhun/git-cliff-action@v4
with:
config: cliff.toml
args: --verbose
github_token: ${{ secrets.DC_GITHUB_PAT }}
env:
OUTPUT: CHANGELOG.md
# Commits and pushes CHANGELOG.md back to main using a Gitea PAT stored as CHANGELOG_PAT
- name: Commit and push if changed (Gitea PAT)
shell: bash
env:
CHANGELOG_PAT: ${{ secrets.CHANGELOG_PAT }}
run: |
set -e
if git diff --quiet -- CHANGELOG.md; then
echo "No changelog changes."
exit 0
fi
git config user.name "changelog-bot"
git config user.email "changelog-bot@users.noreply.local"
git add CHANGELOG.md
git commit -m "docs(changelog): update changelog [skip ci]"
origin_url="$(git remote get-url origin)"
# Convert SSH origin to HTTPS if needed (git@host:owner/repo.git -> https://host/owner/repo.git)
if echo "$origin_url" | grep -q "^git@"; then
host="$(echo "$origin_url" | sed -E 's#git@([^:]+):.*#\1#')"
path="$(echo "$origin_url" | sed -E 's#git@[^:]+:(.*)#\1#')"
origin_url="https://$host/$path"
fi
# Inject token into https:// URL (https://host/owner/repo.git -> https://oauth2:TOKEN@host/owner/repo.git)
authed_url="$(echo "$origin_url" | sed -E "s#^https://#https://oauth2:${CHANGELOG_PAT}@#")"
git push "$authed_url" HEAD:main

View File

@@ -0,0 +1,235 @@
name: Changelog + Release on main
on:
push:
branches: [ main ]
workflow_dispatch:
jobs:
changelog_and_release:
runs-on: ubuntu-latest
steps:
- name: Checkout (full history + tags)
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Stop if this is the bot changelog commit
shell: bash
run: |
set -e
msg="$(git log -1 --pretty=%B)"
echo "$msg" | tr -d '\r' | grep -qi "\[skip ci\]" && {
echo "Skipping (bot commit with [skip ci])"
exit 0
} || true
- name: Install git-cliff
shell: bash
run: |
set -e
GIT_CLIFF_VERSION="2.11.0"
URL="https://github.com/orhun/git-cliff/releases/download/v${GIT_CLIFF_VERSION}/git-cliff-${GIT_CLIFF_VERSION}-x86_64-unknown-linux-gnu.tar.gz"
curl -L "$URL" -o /tmp/git-cliff.tar.gz
tar -xzf /tmp/git-cliff.tar.gz -C /tmp
sudo install /tmp/git-cliff-*/git-cliff /usr/local/bin/git-cliff
git-cliff --version
- name: Generate CHANGELOG.md (Keep a Changelog)
shell: bash
run: |
set -e
git-cliff --config cliff.toml --output CHANGELOG.md
test -s CHANGELOG.md
- name: Commit and push CHANGELOG.md if changed (CHANGELOG_PAT)
shell: bash
env:
CHANGELOG_PAT: ${{ secrets.CHANGELOG_PAT }}
run: |
set -e
if git diff --quiet -- CHANGELOG.md; then
echo "No changelog changes."
else
git config user.name "changelog-bot"
git config user.email "changelog-bot@users.noreply.local"
git add CHANGELOG.md
git commit -m "docs(changelog): update changelog [skip ci]"
origin_url="$(git remote get-url origin)"
# Convert SSH origin to HTTPS if needed
if echo "$origin_url" | grep -q "^git@"; then
host="$(echo "$origin_url" | sed -E 's#git@([^:]+):.*#\1#')"
path="$(echo "$origin_url" | sed -E 's#git@[^:]+:(.*)#\1#')"
origin_url="https://$host/$path"
fi
authed_url="$(echo "$origin_url" | sed -E "s#^https://#https://oauth2:${CHANGELOG_PAT}@#")"
git push "$authed_url" HEAD:main
fi
- name: Extract newest changelog section for release body
shell: bash
run: |
set -e
# Extract the first "## ..." section (newest section) from CHANGELOG.md
# Includes the "## ..." heading and everything until the next "## ..." heading.
awk '
/^## / { if (seen) exit; seen=1 }
seen { print }
' CHANGELOG.md > RELEASE_NOTES.md
# Clean trailing whitespace/newlines a bit
sed -i 's/[[:space:]]*$//' RELEASE_NOTES.md
test -s RELEASE_NOTES.md
echo "---- RELEASE_NOTES.md ----"
head -n 60 RELEASE_NOTES.md
echo "--------------------------"
- name: Create export zip (Computing:Box Website.zip)
shell: bash
run: |
set -e
if [ ! -d "export" ]; then
echo "❌ export/ folder not found in repo root"
ls -la
exit 1
fi
rm -f "Computing:Box Website.zip"
(cd export && zip -r "../Computing:Box Website.zip" .)
test -s "Computing:Box Website.zip"
ls -lh "Computing:Box Website.zip"
- name: Prepare YY.MM.DD letter-suffix tag + release name
shell: bash
run: |
set -e
# Version: YY.MM.DD (UTC). Swap to `date +...` if you prefer UK-local runner time.
VERSION="$(date -u +'%y.%m.%d')"
PREFIX="v${VERSION}."
last_letter="$(
git tag --list "${PREFIX}[a-z]" \
| sed -E "s/^${PREFIX}([a-z])$/\1/" \
| sort \
| tail -n 1
)"
if [ -z "$last_letter" ]; then
next_letter="a"
else
if [ "$last_letter" = "z" ]; then
echo "❌ Already have v${VERSION}.z today. Refusing to create more than 26 releases/day."
exit 1
fi
next_letter="$(printf "%b" "$(printf '\\%03o' "$(( $(printf '%d' "'$last_letter") + 1 ))")")"
fi
TAG="${PREFIX}${next_letter}"
RELEASE_NAME="Computing:Box v${VERSION}.${next_letter}"
echo "TAG=$TAG" >> "$GITHUB_ENV"
echo "RELEASE_NAME=$RELEASE_NAME" >> "$GITHUB_ENV"
echo "ZIP_PATH=Computing:Box Website.zip" >> "$GITHUB_ENV"
echo "Using tag: $TAG"
echo "Release name: $RELEASE_NAME"
- name: Create and push tag (CHANGELOG_PAT)
shell: bash
env:
CHANGELOG_PAT: ${{ secrets.CHANGELOG_PAT }}
run: |
set -e
git tag -f "$TAG"
origin_url="$(git remote get-url origin)"
# Convert SSH origin to HTTPS if needed
if echo "$origin_url" | grep -q "^git@"; then
host="$(echo "$origin_url" | sed -E 's#git@([^:]+):.*#\1#')"
path="$(echo "$origin_url" | sed -E 's#git@[^:]+:(.*)#\1#')"
origin_url="https://$host/$path"
fi
authed_url="$(echo "$origin_url" | sed -E "s#^https://#https://oauth2:${CHANGELOG_PAT}@#")"
git push "$authed_url" "refs/tags/$TAG" --force
- name: Create Gitea release + upload asset (CHANGELOG_PAT)
shell: bash
env:
CHANGELOG_PAT: ${{ secrets.CHANGELOG_PAT }}
run: |
set -e
origin_url="$(git remote get-url origin)"
if echo "$origin_url" | grep -q "^git@"; then
host="$(echo "$origin_url" | sed -E 's#git@([^:]+):.*#\1#')"
path="$(echo "$origin_url" | sed -E 's#git@[^:]+:(.*)#\1#')"
origin_url="https://$host/$path"
fi
base="$(echo "$origin_url" | sed -E 's#(https?://[^/]+)/.*#\1#')"
repo_path="$(echo "$origin_url" | sed -E 's#https?://[^/]+/##')"
repo_path="$(echo "$repo_path" | sed -E 's/\.git$//')"
owner="$(echo "$repo_path" | cut -d/ -f1)"
repo="$(echo "$repo_path" | cut -d/ -f2-)"
api="$base/api/v1"
python3 - <<'PY'
import json, os
tag = os.environ["TAG"]
name = os.environ["RELEASE_NAME"]
with open("RELEASE_NOTES.md", "r", encoding="utf-8") as f:
body = f.read()
payload = {
"tag_name": tag,
"target_commitish": "main",
"name": name,
"body": body, # newest section only
"draft": False,
"prerelease": False,
}
with open("release.json", "w", encoding="utf-8") as f:
json.dump(payload, f)
PY
curl -sS -X POST \
-H "Authorization: Bearer ${CHANGELOG_PAT}" \
-H "Content-Type: application/json" \
"${api}/repos/${owner}/${repo}/releases" \
--data-binary @release.json \
-o release_response.json
release_id="$(python3 - <<'PY'
import json
with open("release_response.json","r",encoding="utf-8") as f:
data=json.load(f)
rid=data.get("id")
if not rid:
raise SystemExit("No release id returned. Response:\n" + json.dumps(data, indent=2))
print(rid)
PY
)"
echo "Created release id: $release_id"
curl -sS -X POST \
-H "Authorization: Bearer ${CHANGELOG_PAT}" \
"${api}/repos/${owner}/${repo}/releases/${release_id}/assets?name=Computing%3ABox%20Website.zip" \
-F "attachment=@${ZIP_PATH}" \
>/dev/null
echo "✅ Release created: ${RELEASE_NAME} (tag: ${TAG}) with asset uploaded"

106
CHANGELOG.md Normal file
View File

@@ -0,0 +1,106 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Conventional Commits](https://www.conventionalcommits.org/).
## [Unreleased]
### Documentation
- update changelog [skip ci]
## [main-29-c9402db] - 2025-12-26
### Documentation
- update changelog [skip ci]
## [main-27-82654d9] - 2025-12-26
### Documentation
- update changelog [skip ci]
- update changelog [skip ci]
- update changelog [skip ci]
## [v1.9] - 2025-12-26
### Added
- migrate CS:Box content to Computing:Box branding
### Bit
- Box Feature Migration
### CI
- add Gitea Actions workflow for site publishing
### Chore
- update CODEOWNERS and remove exported site artifacts
- reorganise project files and add exported pages
- add git-cliff config
- standardise analytics, branding, and licensing across exported pages
### Documentation
- apply Creative Commons licence to V1 exported site
- v1.9
- update changelog [skip ci]
### Reverted
- revert 268a82f17c00792b8e678b5fb93383ae36200dfc
revert ci(deploy): add Gitea Actions workflow for site publishing
- Add publish workflow to deploy main branch via SFTP
- Configure workflow dispatch and push-to-main triggers
- Use repository variables and secrets for SSH credentials
- Update README logo markup for consistent sizing
Signed-off-by: Alexander Davis <alex@adcm.uk>
### Signed-off-by
- Alexander Davis <alex@adcm.uk>
<!-- generated by git-cliff -->

View File

@@ -1,81 +1,56 @@
# git-cliff ~ configuration file # git-cliff configuration
# https://git-cliff.org/docs/configuration # Keep a Changelog compatible
# Safe for first run with no tags
[changelog] [changelog]
# A Tera template to be rendered as the changelog's header.
# See https://keats.github.io/tera/docs/#introduction
header = """ header = """
# Changelog\n # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n and this project adheres to [Conventional Commits](https://www.conventionalcommits.org/).
""" """
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
body = """ body = """
{% if version -%} {% if version %}
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} ## [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else -%} {% else %}
## [Unreleased] ## [Unreleased]
{% endif -%} {% endif %}
{% for group, commits in commits | group_by(attribute="group") %} {% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }} ### {{ group }}
{% for commit in commits %}
- {{ commit.message | split(pat="\n") | first | upper_first | trim }}\ {% for commit in commits %}
{% endfor %} - {{ commit.message | trim }}
{% endfor %}\n
"""
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
footer = """
{% for release in releases -%}
{% if release.version -%}
{% if release.previous.version -%}
[{{ release.version | trim_start_matches(pat="v") }}]: \
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
/compare/{{ release.previous.version }}..{{ release.version }}
{% else -%}
[{{ release.version | trim_start_matches(pat="v") }}]: \
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
/tree/{{ release.version }}
{% endif -%}
{% else -%}
[unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
/compare/{{ release.previous.version }}..HEAD
{% endif -%}
{% endfor %} {% endfor %}
{% endfor %}
"""
footer = """
<!-- generated by git-cliff --> <!-- generated by git-cliff -->
""" """
# Remove leading and trailing whitespaces from the changelog's body.
trim = true trim = true
[git] [git]
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
conventional_commits = true conventional_commits = true
# Exclude commits that do not match the conventional commits specification.
filter_unconventional = false filter_unconventional = false
# An array of regex based parsers for extracting data from the commit message. split_commits = false
# Assigns commits to groups.
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
commit_parsers = [ commit_parsers = [
{ message = "^[a|A]dd", group = "Added" }, { message = "^feat", group = "Added" },
{ message = "^[s|S]upport", group = "Added" }, { message = "^fix", group = "Fixed" },
{ message = "^[r|R]emove", group = "Removed" }, { message = "^docs", group = "Documentation" },
{ message = "^.*: add", group = "Added" }, { message = "^style", group = "Styling" },
{ message = "^.*: support", group = "Added" }, { message = "^refactor", group = "Changed" },
{ message = "^.*: remove", group = "Removed" }, { message = "^perf", group = "Performance" },
{ message = "^.*: delete", group = "Removed" }, { message = "^test", group = "Tests" },
{ message = "^test", group = "Fixed" }, { message = "^build", group = "Build" },
{ message = "^fix", group = "Fixed" }, { message = "^ci", group = "CI" },
{ message = "^.*: fix", group = "Fixed" }, { message = "^chore", group = "Chore" },
{ message = "^.*", group = "Changed" }, { message = "^revert", group = "Reverted" }
] ]
# Prevent commits that are breaking from being excluded by commit parsers.
filter_commits = false protect_breaking_commits = false
# Order releases topologically instead of chronologically.
topo_order = false
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
sort_commits = "oldest" sort_commits = "oldest"