You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2026/10/14 10:45:37 UTC
(plc4x) branch develop updated: docs(agents): point agents at the ASF GitHub Actions rules
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/develop by this push:
new 9ce443d216 docs(agents): point agents at the ASF GitHub Actions rules
9ce443d216 is described below
commit 9ce443d216c626069916778eeded9ea268f912dc
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Wed Oct 14 12:45:13 2026 +0200
docs(agents): point agents at the ASF GitHub Actions rules
#2816 cut the load PLC4X puts on the shared ASF runners: a PR-scoped
concurrency group on the platform workflows, ubuntu-slim for short jobs,
and grouped Dependabot updates. Nothing in the repository says why those
settings exist, so the next new or edited workflow can quietly drop them.
AGENTS.md now links Infra's mandatory GitHub Actions policy and its queue
guidance, and lists what that means here: the concurrency block to copy,
when to use ubuntu-slim, grouped Dependabot ecosystems, SHA-pinned and
approved external actions, no pull_request_target, and the matrix limit.
---
AGENTS.md | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
index ae79cc8317..59c8db6083 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -15,3 +15,33 @@ properties, and known non-findings before reporting issues. Apache PLC4X is a
client library for industrial protocols (most of which are unauthenticated /
unencrypted by design); the threat model is about which threats the library
takes on versus which are left to the operator and the OT network.
+
+## CI workflows and Dependabot
+
+GitHub Actions runners are shared by every ASF project. Agents adding or
+editing anything under `.github/` must follow Infra's
+[GitHub Actions policy](https://infra.apache.org/github-actions-policy.html)
+(mandatory) and its
+[guidance on reducing queue load](https://infra.apache.org/services.html#github-actions).
+In this repository that means:
+
+- Platform workflows that run on pull requests carry the concurrency group
+ already used in `java-platform.yml`, so a new push to a PR cancels its
+ earlier runs. Pushes to `develop` are never cancelled:
+
+ ```yaml
+ concurrency:
+ group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+ ```
+
+- Short jobs that need no Docker run on `ubuntu-slim` (1 vCPU, 15 minute
+ limit), not `ubuntu-latest`.
+- Each Dependabot ecosystem in `.github/dependabot.yml` groups both version
+ updates and `applies-to: security-updates`, so each ecosystem opens one PR
+ instead of one per dependency.
+- Actions outside `apache/*`, `github/*` and `actions/*` are pinned to a full
+ commit SHA and must be on Infra's approved list
+ ([apache/infrastructure-actions](https://github.com/apache/infrastructure-actions)).
+- No `pull_request_target`, and no matrix above 20 concurrent jobs per
+ workflow (15 or fewer recommended).