Set up assign milestone to use base environment variables, not branch

[seanbudd]

Link to issue number:

Fixup #16779

Summary of the issue:

The GitHub actions to assign milestones to closed issues and PRs is failing for community PRs.
This is because the action is looking in the forks repository for the milestone ID environment variable.

Description of user facing changes

Fixes assigning milestones to community contributions

Description of development approach

using the pull_request_target event rather than pull_request, uses the target (i.e. this) repositories environment variables.

Testing strategy:

Known issues with pull request:

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

Summary by CodeRabbit

• New Features

  • Enhanced GitHub Actions workflow for automatically assigning milestones upon closure of issues and pull requests.

• Improvements

  • Increased security and functionality by switching to a more secure context for pull request handling.
  • Explicitly defined permissions to ensure proper access for modifying milestones.

[coderabbitai]

Walkthrough

The changes enhance the GitHub Actions workflow for handling issues and pull requests upon closure. By transitioning from pull_request to pull_request_target, the workflow leverages a more secure context, especially for forked repositories. Additionally, explicit permissions are granted for modifying both issues and pull requests, ensuring the workflow can effectively manage milestones upon closure. Overall, these updates improve both functionality and security.

Changes

Files	Change Summary
.github/workflows/assign-milestone-on-close.yml	Transitioned from pull_request to pull_request_target, updated permissions to allow writing to issues and pull requests, and revised variable references for correct context use.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Workflow

    User->>GitHub: Closes Pull Request
    GitHub->>Workflow: Trigger on pull_request_target
    Workflow->>Workflow: Check permissions (issues: write, pull-requests: write)
    Workflow->>GitHub: Update milestone
    GitHub->>User: Milestone updated

Loading

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a2bbd4c and 6e48cd7.

Files selected for processing (1)

• .github/workflows/assign-milestone-on-close.yml (3 hunks)

Additional comments not posted (3)

.github/workflows/assign-milestone-on-close.yml (3)

9-9: Switch to pull_request_target is appropriate.

Changing the event from pull_request to pull_request_target ensures that the workflow uses environment variables from the base repository, enhancing security for forked repositories.

---

12-14: Explicit permissions are well-defined.

Setting explicit permissions for issues and pull requests ensures the workflow has the necessary access to modify milestones, aligning with best practices.

---

26-26: Context updates align with pull_request_target.

Updating issueOrPr and issueOrPrNumber to use context.payload.pull_request_target ensures the workflow operates with the correct context, consistent with the event change.

Also applies to: 39-39

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: License check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/vyy9cs9yjsj8ggg9/artifacts/output/nvda_snapshot_pr16974-33296,4991b59c.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.4,
  INSTALL_END 1.0,
  BUILD_START 0.0,
  BUILD_END 12.7,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.4,
  TEST_START 0.0,
  TEST_END 18.5,
  FINISH_END 0.2

See test results for failed build of commit 4991b59c1d