Skip to content

feat: add artifact upload steps for JSONL logs in local and remote test workflows #3905

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 7 commits into from
May 9, 2025

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented May 8, 2025

Description

Upload the report logs to independent artifacts so we don't have to download huge files. Keeping the report files in the zip too.

Issue linked

NA

Checklist

Summary by Sourcery

Enhance GitHub Actions workflows to upload JSONL log files as separate artifacts for both local and remote test workflows

Enhancements:

  • Improve log artifact management by separating JSONL log files from other artifacts

CI:

  • Update GitHub Actions workflows to use actions/upload-artifact@v4.6.2
  • Add new step to upload JSONL log files as independent artifacts in local and remote test workflows
  • Update pytest-summary action to download JSONL artifacts

@germa89 germa89 requested a review from a team as a code owner May 8, 2025 13:49
@germa89 germa89 requested review from clatapie and pyansys-ci-bot May 8, 2025 13:49
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

Copy link

sourcery-ai bot commented May 8, 2025

Reviewer's Guide

This pull request modifies the GitHub Actions workflows (test-remote.yml and test-local.yml) to upload JSONL report logs as distinct artifacts. This is achieved by adding new steps using actions/upload-artifact@v4.6.2 in both workflows. Correspondingly, the pytest-summary/action.yml has been updated to download these JSONL artifacts by specifying a pattern in the actions/download-artifact step. Additionally, all instances of actions/upload-artifact across the modified workflows have been standardized to version v4.6.2.

File-Level Changes

Change Details Files
Added dedicated artifact upload for JSONL report logs in test workflows.
  • Added a new step to upload ${{ inputs.file-name }}.jsonl artifacts.
  • Configured the new upload step to always run using if: always() condition.
.github/workflows/test-remote.yml
.github/workflows/test-local.yml
Enabled pytest-summary action to process new JSONL artifacts.
  • Modified the artifact download step to include *.jsonl files by adding pattern: "*.jsonl".
.github/actions/pytest-summary/action.yml
Standardized actions/upload-artifact version across workflows.
  • Updated existing actions/upload-artifact steps from v4 or master to v4.6.2.
.github/workflows/test-remote.yml
.github/workflows/test-local.yml

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

@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc) new feature Request or proposal for a new feature labels May 8, 2025
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 @germa89 - I've reviewed your changes - here's some feedback:

  • Consider if the .jsonl files should still be part of the logs-*.tgz archive, given they are now separate artifacts intended to help avoid downloading large files.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: 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.

Copy link

codecov bot commented May 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.34%. Comparing base (8809b5a) to head (9d80f6e).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3905      +/-   ##
==========================================
+ Coverage   88.32%   88.34%   +0.01%     
==========================================
  Files         187      187              
  Lines       14830    14830              
==========================================
+ Hits        13099    13101       +2     
+ Misses       1731     1729       -2     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 self-assigned this May 8, 2025
@germa89
Copy link
Collaborator Author

germa89 commented May 9, 2025

@pyansys-ci-bot LGTM.

@germa89 germa89 enabled auto-merge (squash) May 9, 2025 09:32
Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@germa89 germa89 merged commit a1a20bc into main May 9, 2025
50 checks passed
@germa89 germa89 deleted the ci/using-different-artifacts-for-reportlog branch May 9, 2025 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc) new feature Request or proposal for a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants