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

[MAINT] update workflow and fix example #905

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

jdkent
Copy link
Member

@jdkent jdkent commented Sep 11, 2024

Closes # .

Changes proposed in this pull request:

Summary by Sourcery

Update the CI workflow by standardizing quotation marks and upgrading artifact actions to the latest version. Fix a key access issue in an example script to ensure correct data retrieval.

Bug Fixes:

  • Fix an issue in the example script by correcting the key used to access the contribution table in the results.

CI:

  • Update the GitHub Actions workflow to use consistent quotation marks and upgrade the 'upload-artifact' and 'download-artifact' actions to version 4.

@jdkent jdkent added the maintenance Issues/PRs related to maintenance/infrastructure. label Sep 11, 2024
Copy link
Contributor

sourcery-ai bot commented Sep 11, 2024

Reviewer's Guide by Sourcery

This pull request updates the GitHub Actions workflow file and fixes an example script. The changes primarily focus on improving the CI/CD pipeline and correcting a minor issue in an example.

File-Level Changes

Change Details Files
Update GitHub Actions workflow file
  • Update actions/upload-artifact and actions/download-artifact to v4
  • Improve formatting and indentation
  • Update commit filter syntax
  • Refactor job dependencies for better readability
.github/workflows/testing.yml
Fix example script
  • Update table key in result.tables to remove '_tail-positive' suffix
examples/02_meta-analyses/12_plot_ibma_workflow.py

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 @jdkent - I've reviewed your changes and they look great!

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 to tell me if it was helpful.

shell: bash {0}
run: make unittest
- name: Upload artifacts
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v4
with:
name: unit_${{ matrix.os }}_${{ matrix.python-version }}
path: coverage.xml
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (performance): Consider using a matrix strategy for performance tests

The jobs for performance tests (estimators, correctors, smoke) are very similar. Consider using a matrix strategy to define these jobs, which could reduce duplication and make the workflow easier to maintain.

  test_performance:
    name: Performance tests
    if: ${{ needs.check_skip.outputs.skip == 'false' }}
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        test-type: [estimators, correctors, smoke]
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: '3.10'
      - name: Run ${{ matrix.test-type }} test
        run: make performance-${{ matrix.test-type }}

@jdkent jdkent merged commit 5fb7ae1 into neurostuff:main Sep 11, 2024
6 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Issues/PRs related to maintenance/infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant