47 Commits

Author SHA1 Message Date
368cf3edca fix
Some checks failed
CI - Docs build check / build-check (push) Successful in 9s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Failing after 3s
2026-02-05 14:12:26 -06:00
279a15f6ad fix
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Failing after 3s
2026-02-05 14:09:23 -06:00
69a34a5a82 test
Some checks failed
CI - Docs build check / build-check (push) Successful in 9s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 4s
Build & publish docs (rc + release) / deploy (push) Failing after 1s
2026-02-05 14:03:24 -06:00
7d7dbe5354 test
Some checks failed
CI - Docs build check / build-check (push) Successful in 13s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 5s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Failing after 2s
2026-02-05 13:58:19 -06:00
ddb44e9846 test
Some checks failed
CI - Docs build check / build-check (push) Successful in 7s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Successful in 6s
Build & publish docs (rc + release) / release (push) Successful in 2s
Build & publish docs (rc + release) / deploy (push) Successful in 1s
2026-02-05 13:47:59 -06:00
f1f4a69bd1 oops
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
Build & publish docs (rc + release) / build (push) Failing after 4s
Build & publish docs (rc + release) / release (push) Has been skipped
Build & publish docs (rc + release) / deploy (push) Has been skipped
2026-02-05 13:40:06 -06:00
dea9106556 test
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
2026-02-05 13:35:51 -06:00
f7345b5433 test
Some checks failed
CI - Docs build check / build-check (push) Failing after 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 5s
2026-02-05 13:30:06 -06:00
a5640d0e02 oops more errors 2026-02-05 13:25:56 -06:00
50252ece04 oops branch name wrong 2026-02-05 13:18:55 -06:00
0fa737e74b test 2026-02-05 13:17:33 -06:00
973dbefabb test 2026-02-05 13:01:37 -06:00
afd82d071c test 2026-02-05 12:44:38 -06:00
ead328c075 fix env
Some checks failed
CI - Docs build check / build-check (push) Failing after 7s
2026-02-05 09:49:35 -06:00
155c9a4222 fix strict var
All checks were successful
CI - Docs build check / build-check (push) Successful in 8s
2026-02-05 09:46:32 -06:00
bdbce0664b fix validation
Some checks failed
CI - Docs build check / build-check (push) Failing after 8s
2026-02-05 09:42:36 -06:00
c185079bf1 fix
All checks were successful
CI - Docs build check / build-check (push) Successful in 9s
2026-02-05 09:28:36 -06:00
039228ab99 update ci
All checks were successful
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Successful in 6s
2026-02-05 09:24:58 -06:00
58d7f6be48 update
All checks were successful
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Successful in 6s
2026-02-05 08:46:15 -06:00
4dd5e308cf update to deploy-rc
Some checks failed
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Failing after 8s
2026-02-05 08:41:17 -06:00
15be04dac7 try rc build
All checks were successful
CI - Docs build check / build-check (push) Successful in 8s
Deploy RC preview to GitHub Pages / deploy-rc-pages (push) Successful in 6s
2026-02-04 18:58:08 -06:00
45da756495 ci (spellcheck, build) 2026-02-04 18:11:22 -06:00
9de000a16d flesh out miscellaneous and dissolution 2026-01-24 18:03:39 -06:00
8af1ab6058 flesh out treasurer and secretary 2026-01-24 18:03:13 -06:00
042abe9f98 remove commissioner power 2026-01-24 18:02:46 -06:00
25a43fe684 capitalization fix 2026-01-24 18:02:26 -06:00
c4d61f1a44 by-laws => Bylaws 2026-01-24 18:02:06 -06:00
b1776e0e39 typo 2026-01-24 18:00:47 -06:00
ac9d5374e9 amend purpose to include members 2026-01-24 18:00:00 -06:00
4913421231 add powers, limitations, office and agent 2026-01-24 17:59:11 -06:00
e1a827cfa1 update spellcheck to use cspell 2026-01-24 17:56:47 -06:00
e9d6761121 split bylaws and policy 2026-01-24 17:10:10 -06:00
51896e9e28 from melanie 2026-01-24 16:17:30 -06:00
dff99c0dc3 from tony 2026-01-24 14:48:18 -06:00
35238a60f3 budget section, unify on "dues" 2026-01-22 09:41:25 -08:00
fbc5061e4a restructure officers, unify on "Commissioner" 2026-01-22 09:41:25 -08:00
1d5d15c6b3 Add directors 2026-01-22 09:41:25 -08:00
0b893a5d8e simplify member standing and voting 2026-01-22 09:41:25 -08:00
9faeba6b7a section -> provision 2026-01-22 09:41:25 -08:00
b96bc44f47 clarify membership. formalize "Manager" 2026-01-22 09:41:25 -08:00
8d619fdc13 amend purpose 2026-01-22 09:41:25 -08:00
cceacae86f Update name section, unify to "League" 2026-01-22 09:41:24 -08:00
cbb9b211b5 promote name and purpose to sections 2026-01-22 07:42:16 -08:00
f21b4efe4a move assets, styles to docs folder 2026-01-22 07:42:11 -08:00
376369f49b implement mkdocs, remove pandoc 2026-01-22 07:29:59 -08:00
fabb2c69fd moved general play section to new document as playing rules 2026-01-22 06:35:06 -08:00
97486f02e1 initial restructuring
directory restructuring, remove makefile and build files in repo
2026-01-20 12:24:27 -06:00
7 changed files with 218 additions and 44 deletions

74
.github/workflows/deploy-pages.yml vendored Normal file
View File

@@ -0,0 +1,74 @@
name: Release - Build and publish docs
on:
push:
tags: ["v*"]
workflow_dispatch:
permissions:
contents: write
jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout (tag)
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
run: |
set -euo pipefail
pip install -r mkdocs/requirements.txt
- name: CI gate build (strict)
env:
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT }}
run: |
set -euo pipefail
export MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
tools/mkdocs_build.sh --config mkdocs/mkdocs.yml
- name: Package site (non-strict)
run: |
set -euo pipefail
export MKDOCS_STRICT="false"
scripts/package_site.sh "${GITHUB_REF_NAME}" --config mkdocs/mkdocs.yml --dist "${RUNNER_TEMP}/dist"
- name: Publish release (GitHub)
uses: softprops/action-gh-release@v2
with:
name: ${{ github.ref_name }}
tag_name: ${{ github.ref_name }}
files: |
${{ runner.temp }}/dist/${{ github.ref_name }}.zip
- name: Remove RC preview from gh-pages (optional cleanup)
run: |
set -euo pipefail
git fetch origin gh-pages:gh-pages || true
if git show-ref --verify --quiet refs/heads/gh-pages; then
git switch gh-pages
else
echo "No gh-pages branch; nothing to clean."
exit 0
fi
if [ -d rc ]; then
rm -rf rc
git add -A
git config user.name "actions-bot"
git config user.email "actions-bot@users.noreply.github.com"
git commit -m "Remove RC preview after release ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages
else
echo "No rc/ directory present; nothing to delete."
fi

76
.github/workflows/deploy-rc-pages.yml vendored Normal file
View File

@@ -0,0 +1,76 @@
name: Deploy RC preview to GitHub Pages
on:
push:
tags: ["rc*"]
workflow_dispatch:
permissions:
contents: write
jobs:
deploy-rc-pages:
runs-on: ubuntu-latest
steps:
- name: Checkout (tag)
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
run: |
set -euo pipefail
pip install -r mkdocs/requirements.txt
- name: Build site (strict default)
run: |
set -euo pipefail
export MKDOCS_STRICT="${MKDOCS_STRICT:-true}"
export TMPDIR="${RUNNER_TEMP:-$TMPDIR}"
export OUTPUT_DIR="${OUTPUT_DIR:-${TMPDIR}/dist/}"
tools/build.sh --config mkdocs/mkdocs.yml
- name: Checkout gh-pages branch
run: |
set -euo pipefail
git fetch origin gh-pages:gh-pages || true
if git show-ref --verify --quiet refs/heads/gh-pages; then
git switch gh-pages
else
git switch --orphan gh-pages
rm -rf ./*
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git commit --allow-empty -m "Initialize gh-pages"
fi
- name: Publish RC preview under /rc/<tag>/
run: |
export TMPDIR="${RUNNER_TEMP:-$TMPDIR}"
export OUTPUT_DIR="${OUTPUT_DIR:-${TMPDIR}/dist/}"
set -euo pipefail
rm -rf "rc"* || true
mkdir -p "rc/"
cp -a "$OUTPUT_DIR/." "rc/"
git add -A
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git commit -m "Deploy RC preview ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages
- name: Publish prerelease (GitHub)
uses: softprops/action-gh-release@v2
with:
prerelease: true
body: |
RC preview: https://<org>.github.io/<repo>/rc/
Tag: ${{ github.ref_name }}
Commit: ${{ github.sha }}

View File

@@ -8,24 +8,22 @@ on:
workflow_dispatch: workflow_dispatch:
permissions: permissions:
contents: write contents: read
env: env:
MKDOCS_CONFIG: mkdocs/mkdocs.yml MKDOCS_CONFIG: mkdocs/mkdocs.yml
MKDOCS_OUTPUT_DIR: ${{ runner.temp }}/dist
MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }} MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT || 'true' }}
jobs: jobs:
publish: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout (tag) - uses: actions/checkout@v4
uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Setup Python - uses: actions/setup-python@v5
uses: actions/setup-python@v5
with: with:
python-version: "3.11" python-version: "3.11"
@@ -34,7 +32,7 @@ jobs:
set -euo pipefail set -euo pipefail
pip install -r mkdocs/requirements.txt pip install -r mkdocs/requirements.txt
- name: Build docs (normal + offline, strict gate) - name: Build docs (strict gate)
run: | run: |
set -euo pipefail set -euo pipefail
@@ -43,22 +41,29 @@ jobs:
FLAGS+=(--strict) FLAGS+=(--strict)
fi fi
OUT_BASE="${RUNNER_TEMP}/mkdocs_out" mkdir -p "${MKDOCS_OUTPUT_DIR}"
SITE="${OUT_BASE}/site"
SITE_OFFLINE="${OUT_BASE}/site_offline/${GITHUB_REF_NAME}"
rm -rf "${OUT_BASE}" OFFLINE="${OFFLINE:-true}" mkdocs build \
mkdir -p "${SITE}" "${SITE_OFFLINE}" "${FLAGS[@]}" \
-f "${MKDOCS_CONFIG}" \
-d "${MKDOCS_OUTPUT_DIR}/offline"
mkdocs build \
"${FLAGS[@]}" \
-f "${MKDOCS_CONFIG}" \
-d "${MKDOCS_OUTPUT_DIR}/dist"
mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${SITE}" - name: Zip site
OFFLINE=true mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${SITE_OFFLINE}"
- name: Zip offline site
run: | run: |
set -euo pipefail set -euo pipefail
cd "${RUNNER_TEMP}/mkdocs_out/site_offline/" cd "${MKDOCS_OUTPUT_DIR}"
zip -r "${GITHUB_REF_NAME}.zip" ./${GITHUB_REF_NAME} zip -r "${GITHUB_REF_NAME}.zip" "./offline"
release:
runs-on: ubuntu-latest
needs: build
steps:
# -------------------------
# RC-only step
# -------------------------
- name: Publish prerelease - name: Publish prerelease
if: startsWith(github.ref_name, 'rc') if: startsWith(github.ref_name, 'rc')
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
@@ -67,10 +72,13 @@ jobs:
name: ${{ github.ref_name }} name: ${{ github.ref_name }}
tag_name: ${{ github.ref_name }} tag_name: ${{ github.ref_name }}
body: | body: |
Release candidate preview. Release candidate preview (if deployed): /rc/
files: | files: |
${{ runner.temp }}/mkdocs_out/site_offline/${{ github.ref_name }}.zip ${{ runner.temp }}/${{ github.ref_name }}.zip
# -------------------------
# Final release-only step
# -------------------------
- name: Publish release - name: Publish release
if: startsWith(github.ref_name, 'v') if: startsWith(github.ref_name, 'v')
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
@@ -78,37 +86,51 @@ jobs:
name: ${{ github.ref_name }} name: ${{ github.ref_name }}
tag_name: ${{ github.ref_name }} tag_name: ${{ github.ref_name }}
files: | files: |
${{ runner.temp }}/mkdocs_out/site_offline/${{ github.ref_name }}.zip ${{ runner.temp }}/${{ github.ref_name }}.zip
deploy:
- name: Checkout gh-pages branch runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout (tag)
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
ref: gh-pages
fetch-depth: 0 fetch-depth: 0
- name: Checkout gh-pages branch
- name: Deploy release to gh-pages root
if: startsWith(github.ref_name, 'v')
run: | run: |
set -euo pipefail set -euo pipefail
rm -rf ./* git fetch origin gh-pages:gh-pages || true
cp -a ${RUNNER_TEMP}/mkdocs_out/site/. . if git show-ref --verify --quiet refs/heads/gh-pages; then
git switch gh-pages
else
git switch --orphan gh-pages
rm -rf ./*
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git commit --allow-empty -m "Initialize gh-pages"
fi
- name: Publish release
run: |
set -euo pipefail
rm -rf ./* || true
cp -a "${MKDOCS_OUTPUT_DIR}/dist/." ""
git add -A git add -A
git config user.name "github-actions[bot]" git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com" git config user.email "github-actions[bot]@users.noreply.github.com"
git commit -m "Deploy release ${GITHUB_REF_NAME}" || echo "No changes to commit" git commit -m "Deploy release ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages git push origin gh-pages
- name: Deploy RC preview to /rc/ - name: Publish RC preview under /rc/<tag>/
if: startsWith(github.ref_name, 'rc')
run: | run: |
set -euo pipefail set -euo pipefail
rm -rf rc rm -rf "rc"* || true
mkdir -p rc mkdir -p "rc/"
cp -a ${RUNNER_TEMP}/mkdocs_out/site/. rc/ cp -a "${MKDOCS_OUTPUT_DIR}/dist/." "rc/"
printf '{"tag":"%s"}\n' "${GITHUB_REF_NAME}" > rc/rc.json
git add -A git add -A
git config user.name "github-actions[bot]" git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com" git config user.email "github-actions[bot]@users.noreply.github.com"
git commit -m "Deploy RC preview ${GITHUB_REF_NAME}" || echo "No changes to commit" git commit -m "Deploy RC preview ${GITHUB_REF_NAME}" || echo "No changes to commit"
git push origin gh-pages git push origin gh-pages

View File

@@ -1,5 +1,5 @@
<p align="center"> <p align="center">
<img src="docs/assets/cmba-logo.svg" width="200"> <img src="assets/cmba-logo.svg" width="200">
</p> </p>
# CMBA Constitution and Bylaws # CMBA Constitution and Bylaws

View File

@@ -1 +1,3 @@
# CMBA Constitution and By-Laws # CMBA Rulebooks
Use the navigation to view the documents.

View File

@@ -1,4 +1,4 @@
site_name: CMBA Constitution and By-Laws site_name: CMBA Rulebook
docs_dir: ../docs docs_dir: ../docs
# Prevent accidental publishing of repo/CI/dev clutter # Prevent accidental publishing of repo/CI/dev clutter

View File

@@ -11,5 +11,5 @@ STRICT_FLAG=""
if [ "${MKDOCS_STRICT}" = "true" ]; then if [ "${MKDOCS_STRICT}" = "true" ]; then
STRICT_FLAG="--strict" STRICT_FLAG="--strict"
fi fi
echo "MKDOCS_STRICT: $MKDOCS_STRICT, STRICT_FLAG: $STRICT_FLAG"
mkdocs build ${STRICT_FLAG} -f $MKDOCS_CONFIG -d $OUTPUT_DIR mkdocs build ${STRICT_FLAG} -f $MKDOCS_CONFIG -d $OUTPUT_DIR