Repository navigation
Docs: общие документы и шаблоны GitHub описывают несколько инструментов - #9
Merged
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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— ссылки на политику безопасности и READMEsqlbrc.Тип изменения
Как проверено
Код Go не менялся —
gofmt/go vet/go test/golangci-lintне требуются; проверялисьдокументы и шаблоны.
.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.safe_load(все три файла).README.mdиCHANGELOG.mdзатронутых инструментов (если требуется).Влияние и риски
sqlbrcи задел дляследующих инструментов.