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.

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

change to use gh api, due to avoid retry #7

Closed
wants to merge 6 commits into from

Conversation

idubnori
Copy link
Owner

@idubnori idubnori commented Apr 21, 2024

Type

enhancement


Description

  • .github/workflows/pr-agent.ymlでGitHub Actionの使用バージョンを変更しました。
  • action.ymlでは、以前のactions/checkoutを使用した方法から、gh apiを使用してWikiページを直接ダウンロードする方法に変更しました。これにより、リトライを避けることができます。

Changes walkthrough

Relevant files
Configuration changes
pr-agent.yml
GitHub Actionのバージョンを変更                                                                     

.github/workflows/pr-agent.yml

  • GitHub
    Actionの使用をidubnori/pr-agent-wiki-conf@developからidubnori/pr-agent-wiki-conf@work/nori/use-gh-api-1に変更

  • +1/-1     
    Enhancement
    action.yml
    Wikiページのダウンロード方法を`gh api`に変更                                                         

    action.yml

  • actions/checkoutを削除し、gh apiを使用してWikiページをダウンロードするように変更
  • mkdir -p wiki_tempを追加して、ダウンロード先のディレクトリを準備
  • +6/-8     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @github-actions github-actions bot added the enhancement New feature or request label Apr 21, 2024
    Copy link

    PR Description updated to latest commit (c206a77)

    Copy link

    PR Review

    ⏱️ Estimated effort to review [1-5]

    2, このPRは比較的小規模で、変更点も明確です。しかし、GitHub APIの使用やエラーハンドリングの確認が必要です。

    🧪 Relevant tests

    No

    🔍 Possible issues

    Possible Bug: gh apiコマンドの実行結果がエラーの場合、そのエラーがスクリプトによって適切に処理されていない可能性があります。これにより、後続のステップで問題が発生するかもしれません。

    🔒 Security concerns

    No

    Code feedback:
    relevant fileaction.yml
    suggestion      

    gh apiコマンドのエラーハンドリングを追加することをお勧めします。例えば、APIコールが失敗した場合に適切なエラーメッセージを出力し、プロセスを安全に終了させることが重要です。 [important]

    relevant linegh api repos/${{ github.repository }}.wiki/contents/${{ inputs.page-name }} --raw > wiki_temp/${{ inputs.page-name }}

    relevant fileaction.yml
    suggestion      

    ダウンロードしたファイルの内容を検証するステップを追加することを提案します。これにより、無効なまたは破損したデータが処理されることを防ぐことができます。 [medium]

    relevant linegh api repos/${{ github.repository }}.wiki/contents/${{ inputs.page-name }} --raw > wiki_temp/${{ inputs.page-name }}


    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

    • When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

    See the review usage page for a comprehensive guide on using this tool.

    @idubnori idubnori force-pushed the work/nori/use-gh-api-1 branch from 7026e67 to 6adcb53 Compare April 21, 2024 08:16
    @idubnori idubnori closed this Apr 21, 2024
    @idubnori idubnori reopened this Apr 21, 2024
    Copy link

    PR Description updated to latest commit (6adcb53)

    @idubnori idubnori closed this Apr 21, 2024
    @idubnori idubnori reopened this Apr 21, 2024
    @idubnori idubnori force-pushed the work/nori/use-gh-api-1 branch from 7b524b0 to 568338e Compare April 21, 2024 08:22
    @idubnori idubnori force-pushed the work/nori/use-gh-api-1 branch from 5616863 to dac74b0 Compare April 21, 2024 08:27
    @idubnori idubnori closed this Apr 21, 2024
    @idubnori idubnori deleted the work/nori/use-gh-api-1 branch April 21, 2024 08:29
    @idubnori idubnori restored the work/nori/use-gh-api-1 branch April 21, 2024 08:30
    @idubnori idubnori reopened this Apr 21, 2024
    @idubnori idubnori closed this Apr 21, 2024
    @idubnori idubnori deleted the work/nori/use-gh-api-1 branch April 21, 2024 09:00
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant