Skip to content

ci: add repository governance and checks - #5

Merged
rhuss merged 6 commits into
mainfrom
ci/governance
Nov 5, 2026
Merged

rhuss merged 6 commits into
mainfrom
ci/governance

Conversation

@rhuss

@rhuss rhuss commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Repository governance and checks for sdk-go. Stacked on #4 (standalone module); review after #4 is merged.

  • CODEOWNERS: @ai-openshell/sdk owns everything, with @ai-openshell/maintainers as fallback reviewers.
  • Dependabot: Go modules weekly (minor and patch grouped) and GitHub Actions daily, both with a 7-day cooldown.
  • CodeQL: Go, manual build (go build ./...), on pull requests, pushes to main, and weekly.
  • DCO: a read-only check that fails when a commit has no Signed-off-by from its author. The Dependabot and sdk bot accounts are exempt. It runs on pull_request without write permissions, unlike core's comment-driven DCO Assistant, whose action repository is archived.
  • Workflow lint: a workflows job in CI runs mise run workflows:check (actionlint with shellcheck, and zizmor). The tools are pinned in mise.toml.
  • Docs: docs.yml builds the mdbook on pull requests that touch docs and deploys it to GitHub Pages (https://ai-openshell.github.io/sdk-go/) from main.
  • Guides: CONTRIBUTING (tasks, sign-off, the pinned core version, core bumps and the drift issue), SECURITY (reports go through NVIDIA/OpenShell's private form until private reporting is enabled here), and AGENTS.

All actions are pinned by commit SHA.

Testing

  • mise run ci and mise run workflows:check pass locally.
  • mise run docs:build builds the book with mdbook 0.5.4.
  • DCO check logic run locally against the import and port branches (pass), an unsigned commit (fail), and a Dependabot commit (exempt).

Part of NVIDIA/OpenShell#5031.

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

Base automatically changed from import/standalone to main November 4, 2026 13:30
rhuss added 4 commits November 4, 2026 14:36
Request reviews from @ai-openshell/sdk, with OpenShell maintainers as
fallback reviewers.

Signed-off-by: Roland Huß <rhuss@redhat.com>
Dependabot updates Go modules weekly (minor and patch grouped) and
GitHub Actions daily, both with a 7-day cooldown. CodeQL scans the Go
code on pull requests, pushes to main, and weekly. The DCO check fails
a pull request when a commit has no Signed-off-by from its author; the
Dependabot and sdk bot accounts are exempt. It runs on pull_request
with read-only permissions instead of core's comment-driven DCO
Assistant, whose action repository is archived.

Signed-off-by: Roland Huß <rhuss@redhat.com>
Pin actionlint, shellcheck, zizmor, and mdbook in mise. The ci workflow
gets a workflows job running actionlint and zizmor; the docs workflow
builds the mdbook on pull requests that touch docs and deploys it to
GitHub Pages from main.

Signed-off-by: Roland Huß <rhuss@redhat.com>
CONTRIBUTING covers the mise tasks, sign-off, the pinned core version,
and how core bumps and the drift issue work. SECURITY routes reports
through NVIDIA/OpenShell's private form until private reporting is set
up here. AGENTS carries the SDK conventions from core's AGENTS.md.

Signed-off-by: Roland Huß <rhuss@redhat.com>
@rhuss
rhuss marked this pull request as ready for review November 4, 2026 13:39
Comment thread .github/workflows/dco.yml Resolved
Comment thread .github/CODEOWNERS Resolved
Comment thread .github/dependabot.yml Resolved
Comment thread CONTRIBUTING.md Resolved
Comment thread SECURITY.md Resolved
Comment thread DCO Resolved
rhuss added 2 commits November 4, 2026 15:54
The org installs the DCO GitHub app on all public repositories, so the
DCO workflow and the DCO file go away; CONTRIBUTING links to the
certificate instead. CONTRIBUTING, SECURITY, and AGENTS are wrapped at
80 columns.

Signed-off-by: Roland Huß <rhuss@redhat.com>
CODEOWNERS assigns .github/ and hack/automation/ (the scripts the
workflows run with the bot token) to @ai-openshell/infra alone, so a
change there needs an infra approval.

Signed-off-by: Roland Huß <rhuss@redhat.com>
@rhuss
rhuss merged commit 88d72c1 into main Nov 5, 2026
7 checks passed
@rhuss
rhuss deleted the ci/governance branch November 5, 2026 14:54
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.

3 participants