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

Add Custom Filename support for coveralls.json #335

Merged
merged 3 commits into from
Jan 16, 2025

Conversation

jowi-dev
Copy link
Contributor

Problem

When running an umbrella app's coveralls in partitioned instances - a way to specify reports is needed for tools like CodeCov to merge reports - this is helpful when running GH actions as a matrix for each app, or even if running the same app in partitions.

Proposal

Leverage the same export flag that exists for .coverdata files and allow the name to be used instead of the hardcoded excoveralls.json if it exists. That way predictable filenames can be given and default behaviour preserved.

@jowi-dev jowi-dev closed this Dec 20, 2024
@jowi-dev jowi-dev reopened this Dec 23, 2024
@jowi-dev
Copy link
Contributor Author

jowi-dev commented Jan 6, 2025

@parroty - Any thoughts on this one?

@parroty
Copy link
Owner

parroty commented Jan 7, 2025

Thanks for the update 🙇 . Could you help me to add some usage examples for understanding the behavior well? (maybe in the README?). I am assuming the default behavior doesn't change and adding this new option might not break existing usage.

@jowi-dev
Copy link
Contributor Author

jowi-dev commented Jan 7, 2025

Hey! So the default behavior is not changed at all, really I wanted a mechanism to piggyback on the existing

test_coverage: [tool: ExCoveralls, export: "myReport"]

Currently in a coveralls.json export, the file would be named excoveralls.json on export no matter what. Once these changes are merged, the file will be exported as myReport.json

I'll add a little spot in the readme for it

@jowi-dev
Copy link
Contributor Author

jowi-dev commented Jan 7, 2025

@parroty README updated

@parroty parroty merged commit 162e71a into parroty:master Jan 16, 2025
3 checks passed
@parroty
Copy link
Owner

parroty commented Jan 16, 2025

Thank you (and sorry being late to respond), please allow some time to publish.

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