Skip to content

Conversation

@marcobarilari
Copy link
Collaborator

@marcobarilari marcobarilari commented Feb 25, 2025

Updated submodule and '.gitmodule' file that was pointing to 'dev' branch

Summary by Sourcery

Updates the bids-matlab submodule and adds a CI workflow to generate a changelog file.

Build:

  • Updates the bids-matlab submodule to the latest version.

CI:

  • Adds a CI workflow to generate a changelog file.

Tests:

  • Adds a test file for the changelog.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 25, 2025

Reviewer's Guide by Sourcery

This pull request updates the bids-matlab submodule, adds a GitHub Actions workflow for generating changelogs, and includes a test file for changelog generation. The submodule update ensures the project uses the correct version of the bids-matlab library. The changelog workflow automates the generation of changelogs based on commit history. The test file was added to test the changelog generation.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the bids-matlab submodule to point to the correct branch.
  • Updated the submodule reference in '.gitmodules'.
  • Updated the submodule itself to the latest commit on the target branch.
.gitmodules
lib/bids-matlab
Added a GitHub Actions workflow for generating changelogs.
  • Created a new workflow file 'changelog.yml' in '.github/workflows/'.
  • Configured the workflow to run on push to master and on pull requests.
  • The workflow uses a Docker container to run the 'github_changelog_generator'.
  • The workflow checks if the commit is a merge commit and not a release before generating the changelog.
.github/workflows/changelog.yml
Added a test file for changelog generation.
  • Added a test file 'changelogTest.m'.
changelogTest.m

Possibly linked issues


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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

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

Overall Comments:

  • Consider whether the conditional logic in the changelog workflow can be simplified for readability.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

- name: Run changelog builder
run: if (git log -1 --pretty=%s | grep Merge*) && (! git log -1 --pretty=%b | grep REL:) ; then

github_changelog_generator --user cpp-lln-lab --project CPP-SPM --token ${CHANGE_TOKEN} \
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (bug_risk): Quote the CHANGE_TOKEN variable in the command.

To avoid issues if the token contains special characters or spaces, wrap ${CHANGE_TOKEN} in double quotes.

Suggested change
github_changelog_generator --user cpp-lln-lab --project CPP-SPM --token ${CHANGE_TOKEN} \
github_changelog_generator --user cpp-lln-lab --project CPP-SPM --token "${CHANGE_TOKEN}" \

@Remi-Gau Remi-Gau changed the title update bids-matlab submodule [MAINT] update bids-matlab submodule Feb 25, 2025
@codecov
Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.75%. Comparing base (f53979a) to head (73f6750).
Report is 169 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1346      +/-   ##
==========================================
+ Coverage   79.57%   81.75%   +2.17%     
==========================================
  Files         285      284       -1     
  Lines        7742     7746       +4     
  Branches       40        0      -40     
==========================================
+ Hits         6161     6333     +172     
+ Misses       1565     1413     -152     
+ Partials       16        0      -16     
Flag Coverage Δ
cli ?
macos-13_matlab-R2023b_fast 63.32% <ø> (?)
macos-13_matlab-R2023b_slow 58.66% <ø> (?)
macos-latest_matlab-R2023a_fast ?
macos-latest_matlab-R2023a_slow ?
octave 76.56% <ø> (+0.85%) ⬆️
ubuntu-latest_matlab-R2023a_fast ?
ubuntu-latest_matlab-R2023a_slow ?
ubuntu-latest_matlab-R2023b_fast 63.32% <ø> (?)
ubuntu-latest_matlab-R2023b_slow 59.15% <ø> (?)
windows-latest_matlab-R2023b_fast 63.32% <ø> (?)
windows-latest_matlab-R2023b_slow 58.66% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Remi-Gau Remi-Gau merged commit 3bafd2b into cpp-lln-lab:main Feb 25, 2025
33 of 34 checks 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