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

[ENH] set up CI #1

Merged
merged 13 commits into from
Aug 20, 2024
Merged

[ENH] set up CI #1

merged 13 commits into from
Aug 20, 2024

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Aug 1, 2024

Summary by Sourcery

This pull request sets up continuous integration (CI) for the project by adding pre-commit hooks, CI workflows for building Docker and Apptainer images, and Dependabot configuration for automatic dependency updates. Additionally, the README.md file has been updated to provide a clearer project description.

  • Enhancements:
    • Updated README.md to provide a more concise description of the project, focusing on Docker and Apptainer images for CAT12.
  • Fix dockerfile
    • update dockerfile and main script to make sure that the image can be built and run. Base dockerfile was generated with neurodocker and adapted from there.
    • required switching to an ubuntu based image rather than a debian one
  • CI:
    • Added .pre-commit-config.yaml to configure pre-commit hooks for YAML, JSON, and Dockerfile linting, as well as code spell checking.
    • Added .github/workflows/apptainer.yml to set up a CI workflow for building Apptainer images on push and pull request events.
    • Added .github/workflows/docker.yml to set up a CI workflow for building ans testing Docker images on push and pull request events.
    • Added .github/dependabot.yml to configure Dependabot for automatic dependency updates for GitHub Actions and git submodules on a monthly schedule.

Copy link
Contributor

sourcery-ai bot commented Aug 1, 2024

Reviewer's Guide by Sourcery

This pull request sets up continuous integration (CI) for the project by adding pre-commit hooks, GitHub Actions workflows for building Docker and Apptainer images, and Dependabot configuration for automated dependency updates. The README.md file has also been updated to reflect the new project name and description.

File-Level Changes

Files Changes
.github/workflows/apptainer.yml
.github/workflows/docker.yml
Added GitHub Actions workflows for building Apptainer and Docker images on push and pull request events targeting the master branch.
.pre-commit-config.yaml
.github/dependabot.yml
Added pre-commit hooks configuration and Dependabot configuration for automated dependency updates.

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.

Copy link
Contributor

@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 @Remi-Gau - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider preserving some of the original structural information in the README, adapting it to the new CAT12 container context if necessary.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟡 Security: 1 issue found
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

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.

.pre-commit-config.yaml Show resolved Hide resolved
.github/workflows/docker.yml Outdated Show resolved Hide resolved
.github/dependabot.yml Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Remi-Gau Remi-Gau merged commit 5f9dd98 into master Aug 20, 2024
4 checks passed
@Remi-Gau Remi-Gau deleted the update branch August 20, 2024 04:02
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