Skip to content

Conversation

@GYFX35
Copy link
Owner

@GYFX35 GYFX35 commented Sep 23, 2025

This commit introduces a GitHub Actions workflow to automatically build and deploy the application to GitHub Pages.

  • Adds a new workflow file at .github/workflows/deploy.yml that triggers on pushes to the main branch.
  • The workflow installs dependencies, builds the application, and deploys the dist directory to the gh-pages branch.
  • Configures package.json with the homepage URL for correct asset pathing.
  • Updates vite.config.js with the base path for the same reason.
  • Modifies the test script in package.json to vitest run to prevent it from running in watch mode in CI environments.

Summary by Sourcery

Add GitHub Pages deployment workflow and configure project settings for correct asset routing and CI testing

New Features:

  • Add GitHub Actions deploy workflow to build and publish the dist directory to gh-pages on main branch pushes

Enhancements:

  • Add homepage field to package.json and base path in vite.config.js for correct asset pathing
  • Modify test script to run vitest in non-watch mode in CI

CI:

  • Configure Node.js setup and use peaceiris/actions-gh-pages in the deployment workflow

This commit introduces a GitHub Actions workflow to automatically build and deploy the application to GitHub Pages.

- Adds a new workflow file at `.github/workflows/deploy.yml` that triggers on pushes to the `main` branch.
- The workflow installs dependencies, builds the application, and deploys the `dist` directory to the `gh-pages` branch.
- Configures `package.json` with the `homepage` URL for correct asset pathing.
- Updates `vite.config.js` with the `base` path for the same reason.
- Modifies the `test` script in `package.json` to `vitest run` to prevent it from running in watch mode in CI environments.
@sourcery-ai
Copy link

sourcery-ai bot commented Sep 23, 2025

Reviewer's Guide

Adds a fully automated GitHub Actions workflow that builds the React application on pushes to main and deploys the output to the gh-pages branch, with accompanying adjustments to project configuration for correct asset paths and CI-friendly test execution.

File-Level Changes

Change Details Files
Introduce GitHub Pages deployment workflow
  • Trigger workflow on pushes to main branch
  • Checkout code and set up Node.js 18
  • Install dependencies and build via npm
  • Deploy contents of dist directory to gh-pages using peaceiris action
.github/workflows/deploy.yml
Configure application asset paths
  • Set homepage URL in package.json
  • Define base path in Vite config for correct routing
package.json
vite.config.js
Adjust test script for CI environments
  • Change test script from "vitest" to "vitest run" to disable watch mode
package.json

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

@GYFX35 GYFX35 merged commit 3e2a126 into main Sep 23, 2025
0 of 6 checks passed
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 there - I've reviewed your changes and they look great!

Blocking issues:

  • An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `.github/workflows/deploy.yml:27` </location>
<code_context>
        uses: peaceiris/actions-gh-pages@v3
</code_context>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

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.

run: npm run build

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
Copy link

Choose a reason for hiding this comment

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

security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha): An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

Source: opengrep

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.

2 participants