Skip to content

docs(ci): explain workflow generation and merge-queue lint #711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mandukhai-Alimaa merged 1 commit into from
Oct 21, 2026
Merged

docs(ci): explain workflow generation and merge-queue lint #711

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion .github/workflows/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
Copyright (c) 2025 ADBC Drivers Contributors
Copyright (c) 2025-2026 ADBC Drivers Contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -18,6 +18,28 @@ limitations under the License.

This directory contains GitHub Actions workflows for automated testing and validation.

## Workflow Generation and Merge-Queue Lint

Regenerate Go and shared development workflows from the repository root:

```bash
uvx --from git+https://github.com/adbc-drivers/dev adbc-gen-workflow generate "$(pwd)"
```

`generate.toml` enables only Go. Regeneration leaves the existing Rust workflows,

@peco-review-bot peco-review-bot Bot Oct 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Medium — The doc describes a regeneration procedure that relies on generate.toml ("generate.toml enables only Go. Regeneration leaves the existing Rust workflows... unchanged."), but no generate.toml exists anywhere in this checkout — the only occurrence of that name in the repo is this README line. A developer following the documented command (uvx --from ... adbc-gen-workflow generate "$(pwd)") would not find the config the doc says controls generation, so the procedure as written isn't reproducible against the current tree.

If generate.toml is introduced by another PR in this stack that hasn't landed in this branch base (the merge-queue workflow and .github/zizmor.yaml from #709 are present, but this file is not), please confirm the stack ordering so the doc and the config land together. Otherwise the file should be added alongside this doc, or the reference path corrected.

Rust Pixi configuration, and Rust lockfile unchanged. Rust FFI tests, Clippy, and
coverage remain in the existing Rust workflows. A future Rust migration must
explicitly enable Rust generation and update its build configuration together.

`merge_queue_lint.yaml` preserves lint on merge groups. Its `lint & pre-commit`
job matches the check from `dev.yaml`, which handles pull requests and pushes.
Keep their lint steps in sync.

`.github/zizmor.yaml` records exceptions for existing findings in custom and
unmigrated Rust workflows, Dependabot configuration, and the existing issue
assignment handler. Exceptions are scoped to individual rules and files; other
checks remain enabled. Regeneration preserves this file.

## Workflows

### C# Build and Test (`csharp.yml`)
Expand Down
Loading