Skip to content

Docs: общие документы и шаблоны GitHub описывают несколько инструментов - #9

Merged
DevOps-spb-ru merged 1 commit into
mainfrom
docs/multi-tool-policy
Sep 22, 2026
Merged

DevOps-spb-ru merged 1 commit into
mainfrom
docs/multi-tool-policy

Conversation

@DevOps-spb-ru

Copy link
Copy Markdown
Owner

Update: SECURITY.md — поддерживаемые версии и область уязвимостей по каждому инструменту, порядок выпуска исправлений
Update: CONTRIBUTING.md — сняты утверждения «только cio»; чеклист релиза с --build-arg DATE; расширен чеклист нового инструмента
Update: README.md, CHANGELOG.md — политика безопасности и указатель журналов для нескольких инструментов
Update: .github/PULL_REQUEST_TEMPLATE.md — чеклист подходит любому инструменту (cio, sqlbrc)
Add: .github/ISSUE_TEMPLATE — варианты sqlbrc и «новый инструмент», ссылки на SECURITY.md и README sqlbrc

Pull Request

Что сделано

Общие документы репозитория были написаны так, будто инструмент один (cio). В репозитории
их два (cio, sqlbrc) и появятся новые, поэтому общая часть приведена к мультиинструментному
виду.

  • SECURITY.md: переписан — поддерживаемые версии таблицей по инструментам, требования к отчёту
    (какой инструмент и его версия), область уязвимостей и «вне области» отдельно для cio и
    sqlbrc, общие пункты (утечка секретов, права файлов, релизные артефакты, workflows) и правило
    расширения политики при добавлении инструмента.
  • CONTRIBUTING.md: сняты устаревшие утверждения («образ пока публикует только cio», «в
    codeql.yml собирается только cio»); в чеклист релиза добавлены --build-arg DATE и образ для
    любого инструмента с контейнерной поставкой; в локальные проверки добавлен
    .work/build-and-test-sqlbrc.ps1 и .work/smoke-container.ps1; чеклист нового инструмента
    расширен (матрицы workflow, релизные job'ы, публичные документы, dependabot.yml, формы issue).
  • README.md (корень): указано, что политика безопасности общая для всех инструментов, а матрицы
    workflow пополняются по чеклисту.
  • CHANGELOG.md (корень): описан порядок пополнения указателя.
  • .github/PULL_REQUEST_TEMPLATE.md: чеклист подходит любому инструменту (в том числе sqlbrc),
    добавлен пункт про общие документы и CI.
  • .github/ISSUE_TEMPLATE/: в формах issue появились sqlbrc и вариант «новый инструмент или
    общая инфраструктура»; в config.yml — ссылки на политику безопасности и README sqlbrc.

Тип изменения

  • Новая функциональность
  • Исправление
  • Документация
  • CI/инфраструктура
  • Рефакторинг без изменения поведения

Как проверено

Код Go не менялся — gofmt/go vet/go test/golangci-lint не требуются; проверялись
документы и шаблоны.

  • Относительные ссылки в markdown проверены скриптом .work/check-doc-links.py:
    10 файлов, 0 битых ссылок.
  • python .work/validate-workflows.py — 6 workflow OK.
  • .work/security/run-workflow-lint.ps1 — actionlint и zizmor: exit 0.
  • YAML форм issue разобран yaml.safe_load (все три файла).
  • Обновлены README.md и CHANGELOG.md затронутых инструментов (если требуется).

Влияние и риски

  • Изменения пользовательского поведения: нет, затронуты только документы и шаблоны GitHub.
  • Обратная совместимость: полная.
  • Формы issue стали длиннее на один вариант — это упрощает отчёты по sqlbrc и задел для
    следующих инструментов.

Update: SECURITY.md — поддерживаемые версии и область уязвимостей по каждому инструменту, порядок выпуска исправлений
Update: CONTRIBUTING.md — сняты утверждения «только cio»; чеклист релиза с --build-arg DATE; расширен чеклист нового инструмента
Update: README.md, CHANGELOG.md — политика безопасности и указатель журналов для нескольких инструментов
Update: .github/PULL_REQUEST_TEMPLATE.md — чеклист подходит любому инструменту (cio, sqlbrc)
Add: .github/ISSUE_TEMPLATE — варианты sqlbrc и «новый инструмент», ссылки на SECURITY.md и README sqlbrc
@DevOps-spb-ru DevOps-spb-ru self-assigned this Sep 22, 2026
@DevOps-spb-ru
DevOps-spb-ru merged commit 2f2ab6c into main Sep 22, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant