Skip to content

Conversation

@chensuyue
Copy link
Contributor

@chensuyue chensuyue commented Nov 17, 2025

User description

Type of Change

bug fix

Description

  1. Fix CI issue for IO build
  2. Open PR test for IO build
  3. Fix code format issue

PR Type

Bug fix, Enhancement, Documentation


Description

  • Add pull request trigger to CI workflow

  • Conditionally push to GitHub based on event

  • Remove benchmark module from API documentation


Diagram Walkthrough

flowchart LR
  A["Add pull request trigger"] -- "on pull_request" --> B["Update build job"]
  B -- "Conditional push" --> C["Remove benchmark module"]
Loading

File Walkthrough

Relevant files
Enhancement
publish.yml
Update CI workflow for pull requests                                         

.github/workflows/publish.yml

  • Added pull_request trigger for master branch
  • Added conditional step for pushing to GitHub
+16/-12 
Documentation
api_2.rst
Remove benchmark from API 2                                                           

docs/source/api-doc/api_2.rst

  • Removed benchmark.rst from toctree
+0/-1     
api_3.rst
Remove benchmark from API 3                                                           

docs/source/api-doc/api_3.rst

  • Removed benchmark.rst from toctree
+0/-7     
benchmark.rst
Remove benchmark.rst                                                                         

docs/source/api-doc/benchmark.rst

  • Deleted entire file
+0/-6     

Signed-off-by: chensuyue <suyue.chen@intel.com>
Signed-off-by: chensuyue <suyue.chen@intel.com>
@PRAgent4INC
Copy link
Collaborator

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Conditional Logic

The conditional logic for pushing to GitHub is not clear. The Push to github step is conditionally executed only if the event is a push, but the PR adds a pull_request trigger. This might lead to confusion about when the push step should execute.

  if: ${{ github.event_name == 'push' }}
- name: Push to github
  uses: peaceiris/actions-gh-pages@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    publish_dir: ./build_tmp/gh-pages
    publish_branch: gh-pages
Permissions

The permissions section includes pull-requests: write, which is not a valid permission. It should be pull-requests: read or removed if not needed.

pull-requests: write
contents: write

@PRAgent4INC
Copy link
Collaborator

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Restrict push action to push events

Ensure the Push to github step is only executed on push events.

.github/workflows/publish.yml [32-37]

 - name: Push to github
+  if: ${{ github.event_name == 'push' }}
   uses: peaceiris/actions-gh-pages@v3
   with:
     github_token: ${{ secrets.GITHUB_TOKEN }}
     publish_dir: ./build_tmp/gh-pages
     publish_branch: gh-pages
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly restricts the Push to github step to only execute on push events. This ensures that the step is not triggered during pull request events, which is a reasonable improvement for maintaining the workflow's intended behavior. However, since the PR already includes this condition, the suggestion offers a marginal improvement.

Medium

pre-commit-ci bot and others added 2 commits November 17, 2025 14:53
Signed-off-by: chensuyue <suyue.chen@intel.com>
@chensuyue chensuyue merged commit 477cb66 into master Nov 18, 2025
13 checks passed
@chensuyue chensuyue deleted the suyue/fix-ci branch November 18, 2025 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants