ci(docs): добавлена еженедельная проверка внешних ссылок (lychee)
- Зачем:
- в роадмапе ~100 внешних ссылок, репозиторий правится редко — ссылки
гниют молча (пункт P1 из project/TODO.md).
- Что:
- добавлен lychee.toml: игнор-лист доменов, режущих ботов (habr, stepik,
leetcode, realpython), YouTube и t.me; исключены project/ и site/.
- добавлен workflow check-links.yml: cron по понедельникам, при битых
ссылках создаёт или обновляет issue с меткой link-check, keepalive
защищает cron от отключения после 60 дней неактивности.
- исправлена битая ссылка на доки datetime в README: перевод /ru/
на docs.python.org отдаёт 404, заменена на английскую версию.
- Проверка:
- docker run --rm -v "$PWD:/input" -w /input lycheeverse/lychee
--no-progress './**/*.md' — 177 ссылок, 0 ошибок, 56 исключено.
- mkdocs build --strict — без ошибок.
- адверсариальное ревью субагентом, 2 раунда — APPROVED.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,54 @@
|
|||||||
|
name: Check external links
|
||||||
|
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 6 * * 1" # понедельник 06:00 UTC
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
issues: write
|
||||||
|
actions: write # для keepalive-шага
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
link-check:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Run lychee
|
||||||
|
id: lychee
|
||||||
|
uses: lycheeverse/lychee-action@v2
|
||||||
|
with:
|
||||||
|
# остальные настройки — в lychee.toml в корне репозитория
|
||||||
|
args: --no-progress './**/*.md'
|
||||||
|
fail: false
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
# если открытый issue с меткой link-check уже есть — обновляем его,
|
||||||
|
# а не создаём дубликат каждую неделю
|
||||||
|
- name: Find open link-check issue
|
||||||
|
if: steps.lychee.outputs.exit_code != 0
|
||||||
|
id: issue
|
||||||
|
run: |
|
||||||
|
echo "number=$(gh issue list --repo "$GITHUB_REPOSITORY" --label link-check --state open --json number --jq '.[0].number // empty')" >> "$GITHUB_OUTPUT"
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ github.token }}
|
||||||
|
|
||||||
|
- name: Create or update issue on broken links
|
||||||
|
if: steps.lychee.outputs.exit_code != 0
|
||||||
|
uses: peter-evans/create-issue-from-file@v5
|
||||||
|
with:
|
||||||
|
title: "Битые внешние ссылки: еженедельная проверка"
|
||||||
|
content-filepath: ./lychee/out.md
|
||||||
|
labels: link-check
|
||||||
|
issue-number: ${{ steps.issue.outputs.number }}
|
||||||
|
|
||||||
|
# GitHub отключает scheduled-workflows после 60 дней без активности
|
||||||
|
# в репозитории; повторное включение сбрасывает таймер
|
||||||
|
- name: Keep scheduled workflow enabled
|
||||||
|
if: always()
|
||||||
|
run: gh api -X PUT "repos/$GITHUB_REPOSITORY/actions/workflows/check-links.yml/enable"
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ github.token }}
|
||||||
@@ -135,7 +135,7 @@ SQL и моделирование данных специально идут р
|
|||||||
- [Работа с файлами в формате CSV, JSON, YAML](https://pyneng.readthedocs.io/ru/latest/book/17_serialization/index.html)
|
- [Работа с файлами в формате CSV, JSON, YAML](https://pyneng.readthedocs.io/ru/latest/book/17_serialization/index.html)
|
||||||
- [Итераторы, итерируемые объекты и генераторы](https://pyneng.readthedocs.io/ru/latest/book/13_iterator_generator/index.html)
|
- [Итераторы, итерируемые объекты и генераторы](https://pyneng.readthedocs.io/ru/latest/book/13_iterator_generator/index.html)
|
||||||
- [Декораторы Python: пошаговое руководство](https://habr.com/ru/companies/otus/articles/727590/)
|
- [Декораторы Python: пошаговое руководство](https://habr.com/ru/companies/otus/articles/727590/)
|
||||||
- Работа с датой/временем: [официальная документация по модулю datetime](https://docs.python.org/ru/3/library/datetime.html)
|
- Работа с датой/временем: [официальная документация по модулю datetime](https://docs.python.org/3/library/datetime.html)
|
||||||
- [Сложность алгоритмов. Разбор Big O](https://habr.com/ru/articles/782608/) — короткий материал, чтобы понимать O(n) vs O(n²) на собеседованиях и в коде
|
- [Сложность алгоритмов. Разбор Big O](https://habr.com/ru/articles/782608/) — короткий материал, чтобы понимать O(n) vs O(n²) на собеседованиях и в коде
|
||||||
- ООП
|
- ООП
|
||||||
- [Tproger: «ООП простыми словами»](https://tproger.ru/experts/oop-in-simple-words)
|
- [Tproger: «ООП простыми словами»](https://tproger.ru/experts/oop-in-simple-words)
|
||||||
|
|||||||
+29
@@ -0,0 +1,29 @@
|
|||||||
|
# Конфигурация lychee — CI-проверка внешних ссылок
|
||||||
|
# Используется в .github/workflows/check-links.yml (подхватывается автоматически)
|
||||||
|
# Локальный запуск: docker run --rm -v "$PWD:/input" -w /input lycheeverse/lychee './**/*.md'
|
||||||
|
|
||||||
|
# Служебные каталоги и каталоги, исключённые из сайта
|
||||||
|
exclude_path = ["project", "site"]
|
||||||
|
|
||||||
|
# Локальные адреса стендов (127.0.0.1, localhost и т.п.)
|
||||||
|
exclude_all_private = true
|
||||||
|
|
||||||
|
exclude = [
|
||||||
|
# Режут ботов и датацентровые IP (проверять вручную из браузера)
|
||||||
|
"^https?://habr\\.com",
|
||||||
|
"^https?://stepik\\.org",
|
||||||
|
"^https?://leetcode\\.com",
|
||||||
|
"^https?://realpython\\.com",
|
||||||
|
# YouTube в CI ненадёжен: 429 на пачку запросов, удалённые видео отдают 200
|
||||||
|
"^https?://(www\\.)?youtube\\.com",
|
||||||
|
"^https?://youtu\\.be",
|
||||||
|
# Telegram отдаёт 200 даже для несуществующих каналов
|
||||||
|
"^https?://t\\.me",
|
||||||
|
]
|
||||||
|
|
||||||
|
# 429 (rate limit) не считаем битой ссылкой
|
||||||
|
accept = ["200..=204", "429"]
|
||||||
|
|
||||||
|
max_retries = 2
|
||||||
|
timeout = 30
|
||||||
|
user_agent = "Mozilla/5.0 (X11; Linux x86_64; rv:128.0) Gecko/20100101 Firefox/128.0"
|
||||||
+6
-7
@@ -4,13 +4,6 @@
|
|||||||
|
|
||||||
## P1
|
## P1
|
||||||
|
|
||||||
- [ ] **CI-проверка внешних ссылок.**
|
|
||||||
В роадмапе ~100 внешних ссылок, репозиторий правится редко — ссылки гниют молча.
|
|
||||||
GitHub Action (например, lychee) по расписанию раз в неделю, с игнор-листом
|
|
||||||
доменов, режущих ботов (habr, stepik, leetcode, realpython и т.п. отвечают
|
|
||||||
только браузерам). Аудит 2026-07-12 нашёл битые ссылки вручную — автоматика
|
|
||||||
избавит от повторов.
|
|
||||||
|
|
||||||
- [ ] **Подраздел «Linux и терминал» в блоке базовых инструментов.**
|
- [ ] **Подраздел «Linux и терминал» в блоке базовых инструментов.**
|
||||||
Единственный пробел заявленной базы: в роадмапе нет ни одного упоминания
|
Единственный пробел заявленной базы: в роадмапе нет ни одного упоминания
|
||||||
bash/ssh/командной строки, при этом все стенды консольные (docker compose,
|
bash/ssh/командной строки, при этом все стенды консольные (docker compose,
|
||||||
@@ -54,6 +47,12 @@
|
|||||||
|
|
||||||
## Сделано
|
## Сделано
|
||||||
|
|
||||||
|
- [x] **CI-проверка внешних ссылок** — 2026-07-12: `lychee.toml` + workflow
|
||||||
|
`check-links.yml` (еженедельно по понедельникам, при битых ссылках создаёт
|
||||||
|
issue). Игнор-лист: habr, stepik, leetcode, realpython (режут ботов),
|
||||||
|
YouTube и t.me (проверка ненадёжна). Попутно исправлена битая ссылка на
|
||||||
|
русские доки Python в README (перевод `/ru/` на docs.python.org умер целиком).
|
||||||
|
|
||||||
- [x] **Убрать раздел «Понятие сложности алгоритмов» из README** —
|
- [x] **Убрать раздел «Понятие сложности алгоритмов» из README** —
|
||||||
2026-07-12, коммит `6f61c0e`: асимптотика перенесена в Python ссылкой
|
2026-07-12, коммит `6f61c0e`: асимптотика перенесена в Python ссылкой
|
||||||
на разбор Big O (habr), по SQL — без дублирования, тему покрывает QPT.
|
на разбор Big O (habr), по SQL — без дублирования, тему покрывает QPT.
|
||||||
|
|||||||
Reference in New Issue
Block a user