Skip to content
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

github-action: Add AsciiDoc freeze warning #16969

Merged
merged 2 commits into from
Jan 30, 2025
Merged

github-action: Add AsciiDoc freeze warning #16969

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9639ea1
github-action: Add AsciiDoc freeze warning
reakaleek Jan 28, 2025
03a7142
github-action: Add AsciiDoc freeze warning
reakaleek Jan 29, 2025
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
21 changes: 21 additions & 0 deletions .github/workflows/comment-on-asciidoc-changes.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Comment on PR for .asciidoc changes

on:
# We need to use pull_request_target to be able to comment on PRs from forks
pull_request_target:
Copy link
Member

Choose a reason for hiding this comment

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

Given the comment-on-asciidoc-changes workflow checks out the code from a PR, allowing the action to run from forks is inherently risky. While I dont see an injection point for execution of malicious code I think it is a significant surface area to try to keep safe. Would it be possible to instead use the github API to detect if files are changed (Rather than checking out the code in the action context? https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests-files )

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you for the feedback.

I just found that the action in use can utilize the GitHub API instead of git.

https://github.com/tj-actions/changed-files?tab=readme-ov-file#using-githubs-api-octocat

I will verify if this works as expected for forks.

types:
- synchronize
- opened
- reopened
branches:
- main
- master
- "9.0"

jobs:
comment-on-asciidoc-change:
permissions:
contents: read
pull-requests: write
uses: elastic/docs-builder/.github/workflows/comment-on-asciidoc-changes.yml@main