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

chore: change docs workflow temp #407

Merged
merged 8 commits into from
Sep 1, 2024
Merged

chore: change docs workflow temp #407

merged 8 commits into from
Sep 1, 2024

Conversation

jamescalam
Copy link
Member

@jamescalam jamescalam commented Aug 31, 2024

PR Type

configuration changes


Description

  • Changed the trigger for the documentation workflow from push to pull_request, which alters when the workflow is executed.
  • Commented out the previous push trigger configuration, which was set to trigger on any tag push.

Changes walkthrough 📝

Relevant files
Configuration changes
docs.yml
Modify documentation workflow trigger to pull requests     

.github/workflows/docs.yml

  • Changed the trigger for the workflow from push to pull_request.
  • Commented out the push trigger configuration.
  • +4/-3     

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

    Copy link

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link

    github-actions bot commented Aug 31, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Enable the workflow for both 'pull_request' and 'push' events

    Consider enabling the workflow for both 'pull_request' and 'push' events to ensure
    that documentation is built and updated on both pull requests and tag pushes. This
    ensures that the documentation is always up-to-date with the latest changes.

    .github/workflows/docs.yml [4-7]

     pull_request:
    -# push:
    -#   tags:
    -#     - '*'
    +push:
    +  tags:
    +    - '*'
     
    Suggestion importance[1-10]: 8

    Why: The suggestion to enable the workflow for both 'pull_request' and 'push' events is valid as it ensures that documentation is built and updated for both scenarios, maintaining up-to-date documentation with the latest changes.

    8

    Copy link

    codecov bot commented Aug 31, 2024

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 63.14%. Comparing base (72e660d) to head (4a41b58).

    Additional details and impacted files
    @@           Coverage Diff           @@
    ##             main     #407   +/-   ##
    =======================================
      Coverage   63.14%   63.14%           
    =======================================
      Files          46       46           
      Lines        3424     3424           
    =======================================
      Hits         2162     2162           
      Misses       1262     1262           

    ☔ View full report in Codecov by Sentry.
    📢 Have feedback on the report? Share it here.

    @jamescalam jamescalam merged commit 04021ac into main Sep 1, 2024
    3 of 6 checks passed
    @jamescalam jamescalam deleted the james/deploy-docs branch September 1, 2024 16:34
    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.

    1 participant