Skip to content

Update documentation.yaml #36

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 27, 2024
Merged

Update documentation.yaml #36

merged 1 commit into from
Jun 27, 2024

Conversation

zunairaahmad1
Copy link
Contributor

@zunairaahmad1 zunairaahmad1 commented Jun 27, 2024 •
edited by github-actions bot
Loading

PR Type

enhancement, configuration changes

Description

  • Added permissions section with read-all permission to the GitHub Actions workflow.
  • Added specific permissions for actions, contents, pull-requests, and issues under the docs job.

Changes walkthrough 📝

Relevant files
Configuration changes
documentation.yaml
Update permissions in GitHub Actions workflow for documentation

.github/workflows/documentation.yaml

  • Added permissions section with read-all permission.
  • Added specific permissions for actions, contents, pull-requests, and
    issues under jobs.docs.
    		•  +7/-0     

    💡 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 documentation Improvements or additions to documentation configuration changes labels Jun 27, 2024
    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Jun 27, 2024 •
    edited
    Loading

    PR Reviewer Guide 🔍

    (Review updated until commit d38adb2)

    ⏱️ Estimated effort to review [1-5] 2
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review Permissions Scope:
    The permissions added to the GitHub Actions workflow seem overly permissive. Specifically, the 'write' permissions for 'actions', 'contents', 'pull-requests', and 'issues' under the 'docs' job might not be necessary if the job is only intended to generate documentation. Consider reducing these permissions to 'read' if write access is not required.

    @github-actions GitHub Actions
    Copy link
    Contributor

    Failed to generate code suggestions for PR

    @zunairaahmad1 zunairaahmad1 reopened this Jun 27, 2024
    @github-actions github-actions bot added enhancement New feature or request Review effort [1-5]: 2 and removed documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Jun 27, 2024
    @github-actions GitHub Actions
    Copy link
    Contributor

    Persistent review updated to latest commit d38adb2

    @github-actions GitHub Actions
    Copy link
    Contributor

    Failed to generate code suggestions for PR

    JoshHilliker
    JoshHilliker approved these changes Jun 27, 2024
    View reviewed changes
    Copy link
    Contributor

    @JoshHilliker JoshHilliker left a comment

    Choose a reason for hiding this comment

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

    LGTM

    @JoshHilliker JoshHilliker merged commit 33b9c58 into main Jun 27, 2024
    @JoshHilliker JoshHilliker deleted the documentation-update branch June 27, 2024 20:55
    @zunairaahmad1 zunairaahmad1 restored the documentation-update branch July 9, 2024 18:22
    @kevinbleckmann kevinbleckmann deleted the documentation-update branch August 26, 2024 16:44
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers
    1 more reviewer

    @JoshHilliker JoshHilliker JoshHilliker approved these changes

    Reviewers whose approvals may not affect merge requirements
    Assignees
    No one assigned
    Labels
    configuration changes enhancement New feature or request Review effort [1-5]: 2
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @zunairaahmad1 @JoshHilliker