Skip to content

Commit

Permalink
Drop references to requesting review from github-actions[bot]
Browse files Browse the repository at this point in the history
I'm confident that this was working as described when I wrote this tool,
but GitHub's behavior appears to have changed and requesting review from
the github-actions[bot] doesn't appear to do anything anymore.

We'll have to run the reviewer on push like other GitHub Actions
automations.
  • Loading branch information
cottsay committed Nov 20, 2024
1 parent eef582b commit 67e4aef
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 8 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,7 @@ $ rosdistro-reviewer --target-ref origin/master

## Running rosdistro-reviewer in GitHub Actions

When a [rosdistro](https://github.com/ros/rosdistro) pull request is opened on GitHub which contains changes that this tool can process, it is invoked using GitHub Actions and the resulting analysis is posted to the pull request as a review by the user `github-actions[bot]`. The rosdistro review team uses the information presented by this review to determine if proposed commits require changes before merging.
When a [rosdistro](https://github.com/ros/rosdistro) pull request is opened or updated on GitHub which contains changes that this tool can process, it is invoked using GitHub Actions and the resulting analysis is posted to the pull request as a review by the user `github-actions[bot]`. The rosdistro review team uses the information presented by this review to determine if proposed commits require changes before merging.

| ![example GitHub pull request review](docs/github_review.png) |
|-|

Unlike typical pull request automation, a new review will not be generated when new changes are pushed to the pull request branch. When you feel that you've sufficiently addressed the feedback given in a previous review, you should re-request review from "GitHub Actions" and a fresh analysis will be performed.

| ![requesting re-review from GitHub Actions](docs/github_review_request.png) |
|-|
Binary file removed docs/github_review_request.png
Binary file not shown.
2 changes: 0 additions & 2 deletions rosdistro_reviewer/submitter/github.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@
ROS Distro includes a very helpful [CONTRIBUTING.md](https://github.com/ros/rosdistro/blob/master/CONTRIBUTING.md) file that we recommend reading if it is your first time submitting a package.
Please also read the [ROS Distro review guidelines](https://github.com/rosdistro/rosdistro/blob/master/REVIEW_GUIDELINES.md) which summarizes this release process.
If you'd like to run this tool again to generate a new review for your PR, [re-request review from GitHub Actions](https://github.com/ros-infrastructure/rosdistro-reviewer?tab=readme-ov-file#running-rosdistro-reviewer-in-github-actions).
# ROS Distro Considerations
* ROS Distributions are created using [REP-134 Standards Track](https://ros.org/reps/rep-0143.html) as a guide.
* Your package name should comply to [REP-144 ROS Package Naming](https://www.ros.org/reps/rep-0144.html)
Expand Down

0 comments on commit 67e4aef

Please sign in to comment.