Skip to content

refactor(workflow): Update comments for clarity and remove unnecessary checkout ref#2435

Merged
manishdait merged 1 commit into
hiero-ledger:mainfrom
danielmarv:dangerous-workflow-sdk-br
Jul 13, 2026
Merged

refactor(workflow): Update comments for clarity and remove unnecessary checkout ref#2435
manishdait merged 1 commit into
hiero-ledger:mainfrom
danielmarv:dangerous-workflow-sdk-br

Conversation

@danielmarv

Copy link
Copy Markdown
Member

Description:
This pull request updates the .github/workflows/bot-pr-missing-linked-issue.yml workflow to improve security and simplify the repository checkout process. The main changes focus on clarifying the workflow's security model and removing an unnecessary configuration from the checkout step.

Workflow security and clarity:

  • Updated the workflow comment to clarify that it relies on the trusted base-branch checkout to avoid executing untrusted fork code, improving the documentation of the workflow’s security considerations.

Workflow configuration simplification:

  • Removed the ref parameter from the actions/checkout step, so it now defaults to checking out the base branch, which is sufficient for this workflow and reduces complexity.

Related issue(s):

Fixes #2434

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

…y checkout ref

Signed-off-by: Ntege Daniel <danientege785@gmail.com>
@github-actions github-actions Bot added approved Issue has been approved by team member skill: intermediate requires some knowledge of the codebase with some defined steps to implement or examples labels Jul 12, 2026
@danielmarv
danielmarv marked this pull request as ready for review July 12, 2026 16:56
Copilot AI review requested due to automatic review settings July 12, 2026 16:56
@danielmarv
danielmarv requested review from a team as code owners July 12, 2026 16:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 bot-pr-missing-linked-issue.yml GitHub Actions workflow documentation and simplifies the checkout step to address OpenSSF Scorecard’s Dangerous-Workflow warning while keeping the workflow’s security posture clear.

Changes:

  • Clarified workflow comments describing the pull_request_target security model (trusted base-branch checkout).
  • Removed the explicit ref: override from actions/checkout, relying on the default base-branch checkout behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The linked-issue bot workflow retains its pull_request_target trigger and reminder behavior while updating its trusted-checkout documentation and removing the explicit base SHA checkout override.

Changes

Workflow checkout security

Layer / File(s) Summary
Trusted checkout configuration
.github/workflows/bot-pr-missing-linked-issue.yml
The workflow comment now describes trusted base-branch checkout, and the repository checkout step no longer specifies the pull-request-derived ref value.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning Issue #2434's testing/evidence requirement is unmet; the PR only changes comments and removes the unsafe ref. Add workflow validation for forked PRs and document the result, such as with a run log or screenshot.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly names the workflow comment update and checkout ref removal, matching the PR changes.
Description check ✅ Passed The description matches the workflow security and checkout simplification changes.
Out of Scope Changes check ✅ Passed The edits stay within the workflow file and align with the stated security and simplification goals.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
📋 Issue Planner

Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).

View plan for ticket: #2434

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 46611dcc-8297-4eef-a70b-24a8eceaf530

📥 Commits

Reviewing files that changed from the base of the PR and between 1de57e3 and b954be1.

📒 Files selected for processing (1)
  • .github/workflows/bot-pr-missing-linked-issue.yml

Comment thread .github/workflows/bot-pr-missing-linked-issue.yml
@github-actions github-actions Bot added open to community review PR is open for community review and feedback queue:junior-committer PR awaiting initial quality review labels Jul 12, 2026
@github-actions github-actions Bot added queue:committers PR awaiting committer technical review and removed queue:junior-committer PR awaiting initial quality review labels Jul 12, 2026
@exploreriii
exploreriii requested a review from aceppaluni July 12, 2026 20:58
@manishdait
manishdait merged commit 89cb9ab into hiero-ledger:main Jul 13, 2026
15 of 18 checks passed
@github-actions

Copy link
Copy Markdown

👋 Hi @danielmarv! Great work completing a Intermediate issue! 🎉

Thanks for your contribution! 🚀

🏆 Milestone unlocked: you've reached Advanced level! 🎉

Here are some issues you might want to explore next:

🌟 Stay connected:

Happy coding! 🚀
— Hiero Python SDK Team

@MonaaEid MonaaEid added this to the v0.2.9 milestone Jul 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Issue has been approved by team member open to community review PR is open for community review and feedback queue:committers PR awaiting committer technical review skill: intermediate requires some knowledge of the codebase with some defined steps to implement or examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix OpenSSF Scorecard Dangerous-Workflow warning in PR linked issue bot

6 participants