4 Commits

Author SHA1 Message Date
0fad347372 updated readme
All checks were successful
Build & publish / publish (push) Successful in 17s
CI - Docs build check / build-check (push) Successful in 8s
2026-04-26 11:26:16 -05:00
55554f25c0 update to have playing rules separate docx 2026-04-26 11:24:44 -05:00
a4d575c07e change link name for summary of changes 2026-04-26 10:57:57 -05:00
f0fbf8662b github action updates
All checks were successful
CI - Docs build check / build-check (push) Successful in 8s
Build & publish / publish (push) Successful in 16s
2026-04-26 10:41:28 -05:00
4 changed files with 38 additions and 3 deletions

View File

@@ -2,6 +2,10 @@ name: CI - Docs build check
on:
push:
tags:
- "draft*"
- "rc*"
- "v*"
branches:
- main
- draft

View File

@@ -1,4 +1,4 @@
name: Build & publish docs (rc + release)
name: Build & publish
on:
push:
@@ -87,6 +87,7 @@ jobs:
OUT_DIR="${RUNNER_TEMP}/pandoc"
OUT_FILE="${GITHUB_REF_NAME}-${SHORT_SHA}.docx"
PLAYING_RULES_OUT_FILE="${GITHUB_REF_NAME}-${SHORT_SHA}-playing-rules.docx"
echo "SHORT_SHA=`echo ${SHORT_SHA}`" >> $GITHUB_ENV
mkdir -p "${OUT_DIR}"
@@ -109,6 +110,16 @@ jobs:
echo "Pandoc output written to ${OUT_DIR}/${OUT_FILE}"
echo "Generating ${PLAYING_RULES_OUT_FILE}"
pandoc \
docs/03-playing-rules.md \
--shift-heading-level-by=-1 \
--number-sections \
-o "${OUT_DIR}/${PLAYING_RULES_OUT_FILE}"
echo "Pandoc output written to ${OUT_DIR}/${PLAYING_RULES_OUT_FILE}"
- name: Zip offline site
run: |
set -euo pipefail
@@ -140,6 +151,7 @@ jobs:
files: |
${{ runner.temp }}/mkdocs_out/site_offline/${{ github.ref_name }}.zip
${{ runner.temp }}/pandoc/${{ github.ref_name }}-${{ env.SHORT_SHA }}.docx
${{ runner.temp }}/pandoc/${{ github.ref_name }}-${{ env.SHORT_SHA }}-playing-rules.docx
- name: Publish release
if: startsWith(github.ref_name, 'v')
@@ -150,6 +162,8 @@ jobs:
body_path: ${{ runner.temp }}/release-notes.md
files: |
${{ runner.temp }}/mkdocs_out/site_offline/${{ github.ref_name }}.zip
${{ runner.temp }}/pandoc/${{ github.ref_name }}-${{ env.SHORT_SHA }}.docx
${{ runner.temp }}/pandoc/${{ github.ref_name }}-${{ env.SHORT_SHA }}-playing-rules.docx
- name: Checkout gh-pages branch
uses: actions/checkout@v4

View File

@@ -45,6 +45,23 @@ MkDocs serves the site locally and watches the Markdown files under `docs/` for
- Use the local preview server when editing headings, internal links, or cross-references.
- Update `tools/spellcheck/baseball-words.txt` when league-specific terminology is flagged by CSpell.
## Amendment Flow
Amendments move through three review stages before publication:
1. Draft amendments are prepared on the `draft` branch. Use this branch for active editing, internal review, and early validation.
2. Drafts may be prereleased for review by pushing a `draft*` tag. The draft prerelease provides a reviewable GitHub release and deploys the draft preview site at `/draft/`.
3. When the draft is ready for formal consideration, merge it into `release-candidate` with a merge commit. The merge commit preserves the point at which the draft moved into release-candidate review.
4. Release candidates may be prereleased for review by pushing an `rc*` tag. The release-candidate prerelease provides the version to be voted on and deploys the release-candidate preview site at `/rc/`.
5. After the amendment is voted on and approved according to the required CMBA process, merge the release candidate into `main`.
6. Publish the approved amendment from `main` by pushing a `v*` tag and creating the final GitHub release.
The final GitHub release is the published record for an approved amendment. It should include:
- an offline HTML version of the documents
- a `.docx` version of the combined bylaws, policy, and playing rules
- a `.docx` version of the playing rules only
## Publishing
Publishing is driven by GitHub Actions.
@@ -67,7 +84,7 @@ It builds both the normal site and an offline site package, then publishes based
- `draft*`: creates a GitHub prerelease, attaches the offline zip and generated `.docx`, and deploys the preview site to the `gh-pages` branch under `/draft/`
- `rc*`: creates a GitHub prerelease, attaches the offline zip and generated `.docx`, and deploys the preview site to the `gh-pages` branch under `/rc/`
- `v*`: creates a GitHub release, attaches the offline zip, and deploys the release site to the root of the `gh-pages` branch
- `v*`: creates a GitHub release, attaches the release artifacts, and deploys the release site to the root of the `gh-pages` branch
The GitHub release description is generated from `docs/summary-of-changes.md`. Draft and release-candidate prereleases prepend a short prerelease note before that summary.

View File

@@ -35,4 +35,4 @@ The Chicago Metropolitan Baseball Association exists to provide strong amateur b
## Additional Resources
- [Summary of High Level Changes for 2026](summary-of-changes.md)
- [Summary of Changes](summary-of-changes.md)