Skip to content

Commit 6936045

Browse files
authored
Merge pull request #23 from Gfermoto/dev
fix(docs): баннер MkDocs + обновление GitHub Actions
2 parents 66fa711 + 38718cb commit 6936045

13 files changed

Lines changed: 35 additions & 25 deletions

.github/workflows/ci-pr.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ jobs:
1818
run:
1919
working-directory: app/ui
2020
steps:
21-
- uses: actions/checkout@v4
21+
- uses: actions/checkout@v6
2222

23-
- uses: actions/setup-node@v4
23+
- uses: actions/setup-node@v6
2424
with:
2525
node-version: "22"
2626
cache: npm
@@ -34,9 +34,9 @@ jobs:
3434
docs:
3535
runs-on: ubuntu-latest
3636
steps:
37-
- uses: actions/checkout@v4
37+
- uses: actions/checkout@v6
3838

39-
- uses: actions/setup-python@v5
39+
- uses: actions/setup-python@v6
4040
with:
4141
python-version: "3.12"
4242
cache: pip

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414

1515
steps:
1616
- name: Checkout
17-
uses: actions/checkout@v4
17+
uses: actions/checkout@v6
1818

1919
- name: Sync to deploy dir
2020
run: |

.github/workflows/docker-publish.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,29 @@ jobs:
1818

1919
steps:
2020
- name: Checkout
21-
uses: actions/checkout@v4
21+
uses: actions/checkout@v6
2222

2323
- name: Set up Docker Buildx
24-
uses: docker/setup-buildx-action@v3
24+
uses: docker/setup-buildx-action@v4
2525

2626
- name: Log in to Container Registry
27-
uses: docker/login-action@v3
27+
uses: docker/login-action@v4
2828
with:
2929
registry: ${{ env.REGISTRY }}
3030
username: ${{ github.actor }}
3131
password: ${{ secrets.GITHUB_TOKEN }}
3232

3333
- name: Extract metadata
3434
id: meta
35-
uses: docker/metadata-action@v5
35+
uses: docker/metadata-action@v6
3636
with:
3737
images: ${{ env.REGISTRY }}/${{ github.repository_owner }}/birdlense-hub
3838
tags: |
3939
type=raw,value=latest,enable=${{ github.ref == 'refs/heads/main' }}
4040
type=semver,pattern={{version}},enable=${{ github.event_name == 'release' }}
4141
4242
- name: Build and push
43-
uses: docker/build-push-action@v5
43+
uses: docker/build-push-action@v7
4444
with:
4545
context: ./app
4646
file: ./app/Dockerfile

.github/workflows/docs-pages.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66
branches: [main, dev]
77
paths:
88
- "docs/**"
9+
- "overrides/**"
910
- "mkdocs.yml"
1011
- "VERSION"
1112
- "requirements-docs.txt"
@@ -29,9 +30,9 @@ jobs:
2930
build:
3031
runs-on: ubuntu-latest
3132
steps:
32-
- uses: actions/checkout@v4
33+
- uses: actions/checkout@v6
3334

34-
- uses: actions/setup-python@v5
35+
- uses: actions/setup-python@v6
3536
with:
3637
python-version: "3.12"
3738
cache: pip
@@ -47,7 +48,7 @@ jobs:
4748
run: mkdocs build --strict
4849

4950
- name: Upload Pages artifact
50-
uses: actions/upload-pages-artifact@v3
51+
uses: actions/upload-pages-artifact@v4
5152
with:
5253
path: site
5354

.github/workflows/wiki-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
runs-on: ubuntu-latest
2020
steps:
2121
- name: Checkout
22-
uses: actions/checkout@v4
22+
uses: actions/checkout@v6
2323

2424
- name: Generate wiki report
2525
run: |
@@ -29,7 +29,7 @@ jobs:
2929
run: cat wiki-report.md >> "$GITHUB_STEP_SUMMARY"
3030

3131
- name: Upload artifact
32-
uses: actions/upload-artifact@v4
32+
uses: actions/upload-artifact@v6
3333
with:
3434
name: wiki-report
3535
path: wiki-report.md

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
1717
### Changed
1818

1919
- **GitHub Pages:** docs workflow triggers on `VERSION` and `scripts/check-docs-version.py` changes; build is strict.
20+
- **GitHub Actions:** `actions/checkout@v6`, `setup-python@v6`, `setup-node@v6`, `upload-pages-artifact@v4`, `upload-artifact@v6`, Docker actions (buildx/login/metadata/build-push v4/v4/v6/v7) — актуальные рантаймы, меньше предупреждений про Node.js 20.
2021

2122
### Fixed
2223

23-
- **Docs (MkDocs strict):** internal links to repo-root files (`.github/`, `scripts/`) and excluded `docs/archive/` now point to GitHub blob URLs so `mkdocs build --strict` passes in CI.
24+
- **MkDocs:** баннер версии через `overrides/main.html` (`{% block announce %}`): в community Material `theme.announcement` в `mkdocs.yml` не рендерится — баннер был пустым; после деплоя отображается **v** из `extra.site_version`.
25+
- **Docs (MkDocs strict):** ссылки на корень репозитория и `docs/archive/` — на blob GitHub, чтобы `mkdocs build --strict` проходил в CI.
2426

2527
---
2628

docs/Documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Build output goes to `site/` (ignored by git).
3737
Workflow [.github/workflows/docs-pages.yml](https://github.com/Gfermoto/BirdLense-Hub/blob/main/.github/workflows/docs-pages.yml):
3838

3939
- On push to **`main`** or **`dev`** when `docs/**`, `mkdocs.yml`, `VERSION`, `requirements-docs.txt`, or `scripts/check-docs-version.py` change (or manually via **Actions → Documentation site → Run workflow**), the site is **built** every run.
40-
- Before build: **`python3 scripts/check-docs-version.py`** — the string from root **`VERSION`** must appear in `mkdocs.yml` (`theme.announcement` and `extra.site_version`) so the banner cannot drift from releases.
40+
- Before build: **`python3 scripts/check-docs-version.py`** — the string from root **`VERSION`** must appear in `mkdocs.yml` (at least `extra.site_version`; the top banner is **`overrides/main.html`**`{% block announce %}` with `config.extra.site_version`).
4141
- Build: **`mkdocs build --strict`** (broken links / nav issues fail CI).
4242
- **Deploy to GitHub Pages** runs only for **`main`**.
4343

docs/Documentation.ru.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ python3 -m venv .venv-docs
3737
Workflow [.github/workflows/docs-pages.yml](https://github.com/Gfermoto/BirdLense-Hub/blob/main/.github/workflows/docs-pages.yml):
3838

3939
- При push в **`main`** или **`dev`** при изменениях в `docs/**`, `mkdocs.yml`, **`VERSION`**, `requirements-docs.txt` или `scripts/check-docs-version.py` (или вручную: **Actions → Documentation site → Run workflow**) сайт **собирается** каждый раз.
40-
- Перед сборкой: **`python3 scripts/check-docs-version.py`** — строка из корневого **`VERSION`** должна быть в `mkdocs.yml` (`theme.announcement` и `extra.site_version`), чтобы баннер не отставал от релиза.
40+
- Перед сборкой: **`python3 scripts/check-docs-version.py`** — строка из корневого **`VERSION`** должна быть в `mkdocs.yml` (как минимум `extra.site_version`; верхний баннер — **`overrides/main.html`**, блок `{% block announce %}`, версия из `config.extra.site_version`).
4141
- Сборка: **`mkdocs build --strict`** (битые ссылки и ошибки навигации роняют CI).
4242
- **Деплой на GitHub Pages** выполняется только для ветки **`main`**.
4343

docs/VERSIONING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Examples:
3232

3333
Update **all three** on each release.
3434

35-
Also update **`mkdocs.yml`**: `theme.announcement` and `extra.site_version` must contain the same semver string as `VERSION` (CI runs `scripts/check-docs-version.py`).
35+
Also update **`mkdocs.yml`**: `extra.site_version` must match `VERSION` (CI: `scripts/check-docs-version.py`). The visible banner is rendered from **`overrides/main.html`** (`announce` block), not from a `theme.announcement` key (Material ignores that in YAML).
3636

3737
---
3838

docs/VERSIONING.ru.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
При релизе обновлять все три.
3131

32-
Также **`mkdocs.yml`**: строка версии в `theme.announcement` и в `extra.site_version` должна совпадать с `VERSION` (проверка в CI: `scripts/check-docs-version.py`).
32+
Также **`mkdocs.yml`**: `extra.site_version` должен совпадать с `VERSION` (CI: `scripts/check-docs-version.py`). Видимый баннер задаётся в **`overrides/main.html`** (блок `announce`), ключ `theme.announcement` в YAML Material не использует.
3333

3434
## Релизы и теги
3535

0 commit comments

Comments
 (0)