Skip to content

Update ACL Documentation for Runners #1665

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.

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
merged 5 commits into from
May 22, 2025
Merged

Update ACL Documentation for Runners #1665

merged 5 commits into from
May 22, 2025

Conversation

fdevans
Copy link
Contributor

@fdevans fdevans commented May 21, 2025

No description provided.

@fdevans fdevans requested a review from Copilot May 21, 2025 15:34
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the ACL documentation to enumerate fine-grained runner actions and clarifies runner resource properties.

  • Expands application and project scope tables with read, create, update, delete, ping, and regenerate_credentials for runner
  • Adds a type-properties row for runner and a note detailing the project and id fields

Copy link
Member

@gschueler gschueler left a comment

Choose a reason for hiding this comment

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

@fdevans fdevans added this to the 5.13.0 milestone May 21, 2025
fdevans and others added 2 commits May 21, 2025 09:12
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@fdevans fdevans requested review from gschueler and Copilot May 21, 2025 16:21
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the ACL documentation by expanding runner permissions with granular actions, updating all relevant tables in both application and project scopes, and adding a resource-level runner section with property notes.

  • Added individual runner actions (read, create, update, delete, ping, regenerate_credentials) under “Managing Runners”
  • Updated application-scope and project-scope tables to list each runner action explicitly
  • Introduced a resource-level runner section and clarified its properties in a note
Comments suppressed due to low confidence (1)

docs/administration/security/authorization.md:205

  • [nitpick] The bullet has an extra hyphen which leads to inconsistent list indentation; remove the redundant hyphen to align with surrounding items.
-  - Read Access to All Runner configuration `read`

@fdevans fdevans requested a review from Copilot May 21, 2025 17:47
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the ACL documentation to add detailed Runner actions and permissions, ensuring that all available Runner operations are clearly documented.

  • Updated the list of Runner actions in the application-wide ACL section.
  • Revised and expanded the Runner entries in the ACL tables across different scopes.
  • Removed duplicate Runner entries from previous sections.

@fdevans fdevans merged commit 9940c20 into 4.0.x May 22, 2025
1 check passed
@fdevans fdevans deleted the runner-ACL-fixes branch May 22, 2025 19:04
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.

2 participants