Skip to content

Conversation

Dargon789
Copy link
Owner

@Dargon789 Dargon789 commented May 9, 2025

What kind of change does this PR introduce?

What is the current behavior?

What is the new behavior?

What steps did you take to test this? This is required before we can merge, make sure to test the flow you've updated.

  1. Step A
  2. Step B
  3. Step C

Checklist

  • Documentation
  • Testing
  • Ready to be merged
  • Added myself to contributors table

Summary by Sourcery

Add GitHub Actions workflow for deploying static content to GitHub Pages

CI:

  • Create a GitHub Actions workflow to automatically deploy static content to GitHub Pages when pushing to the main branch

Deployment:

  • Configure GitHub Pages deployment with automatic artifact upload and page deployment

Signed-off-by: AU_gdev_19 <[email protected]>
Copy link

codesandbox bot commented May 9, 2025

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

sourcery-ai bot commented May 9, 2025

Reviewer's Guide

This pull request introduces a new GitHub Actions workflow designed to automate the deployment of static content to GitHub Pages. The workflow is triggered on pushes to the main branch or manually, and it handles the checkout, setup, artifact creation (uploading the entire repository), and deployment steps necessary for GitHub Pages.

File-Level Changes

Change Details Files
Added a GitHub Actions workflow to deploy static content to GitHub Pages.
  • Created a new workflow file static.yml.
  • Configured the workflow to trigger on pushes to the main branch and on workflow_dispatch.
  • Set permissions for GITHUB_TOKEN to allow deployment to GitHub Pages (contents: read, pages: write, id-token: write).
  • Defined a concurrency setting to ensure only one deployment runs at a time for the pages group, without cancelling in-progress runs.
  • Added a single deploy job that runs on ubuntu-latest.
  • The deploy job includes steps to checkout the repository, configure GitHub Pages, upload the entire repository content as a pages artifact, and deploy to GitHub Pages using standard actions (actions/checkout@v4, actions/configure-pages@v5, actions/upload-pages-artifact@v3, actions/deploy-pages@v4).
.github/workflows/static.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Repository owner deleted a comment from vercel bot May 9, 2025
Copy link

snyk-io bot commented May 9, 2025

🎉 Snyk checks have passed. No issues have been found so far.

security/snyk check is complete. No issues have been found. (View Details)

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Dargon789 - I've reviewed your changes - here's some feedback:

  • Consider using a specific output directory in upload-pages-artifact.path (e.g., dist/ or public/) instead of . to deploy only necessary static files.
  • If a build step is needed to generate static content, ensure it's added to this workflow before the Upload artifact step.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Dargon789 Dargon789 merged commit b2a3681 into main May 9, 2025
17 of 20 checks passed
@Dargon789 Dargon789 deleted the Dargon789-patch-1 branch May 9, 2025 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant