Skip to content

chore: add build pipeline #126

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

Merged
merged 4 commits into from
Aug 31, 2024
Merged

chore: add build pipeline #126

merged 4 commits into from
Aug 31, 2024

Conversation

AsCress
Copy link
Contributor

@AsCress AsCress commented Aug 31, 2024

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
  • Bug fix
  • Feature implementation
  • Doc updates
  • Related Issue
    N/A

  • What changes have you introduced?
    This PR adds a build pipeline which checks for a successful build on every pull request.

  • Does this PR introduce a breaking change?
    No

  • Preview / Steps to verify your work:
    N/A

Summary by Sourcery

Introduce a build pipeline using GitHub Actions to ensure successful builds on pull requests to the master branch.

Build:

  • Add a GitHub Actions workflow to automate the build process for pull requests targeting the master branch.

Copy link

sourcery-ai bot commented Aug 31, 2024

Reviewer's Guide by Sourcery

This pull request introduces a new build pipeline using GitHub Actions. The pipeline is configured to run on every pull request to the master branch, ensuring that the project builds successfully before merging.

File-Level Changes

Change Details Files
Implement GitHub Actions workflow for build process
  • Set up workflow to trigger on pull requests to master branch
  • Configure job to run on ubuntu-latest
  • Set up Python 3.8 environment
  • Install project dependencies from requirements.txt
  • Execute 'make html' command to build the project
  • Copy images and CNAME file to the build output
  • Create .nojekyll file in the build output
.github/workflows/pull-request.yml

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@AsCress AsCress requested a review from adityastic August 31, 2024 04:52
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 @AsCress - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a separate test step to the workflow to ensure both building and testing are performed.
  • The workflow includes steps like copying images, CNAME file, and creating a .nojekyll file. These seem more related to deployment than building. Consider separating these into a deployment workflow if they're not necessary for every build.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 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 to tell me if it was helpful.

@adityastic adityastic merged commit ab8e8f4 into fossasia:master Aug 31, 2024
1 check passed
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