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

feat(reana-dev): add git-aggregate-changelog (#789) #789

Merged
merged 1 commit into from
Mar 13, 2024

Conversation

mdonadoni
Copy link
Member

No description provided.

mdonadoni added a commit to mdonadoni/reana that referenced this pull request Mar 7, 2024
@mdonadoni mdonadoni force-pushed the aggregate-changes branch from 67485c2 to 1dc8d2a Compare March 7, 2024 14:35
Copy link

codecov bot commented Mar 7, 2024

Codecov Report

Attention: Patch coverage is 8.73786% with 94 lines in your changes are missing coverage. Please review.

Project coverage is 18.15%. Comparing base (a4cb84c) to head (6210b11).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #789      +/-   ##
==========================================
- Coverage   18.56%   18.15%   -0.41%     
==========================================
  Files          26       26              
  Lines        2375     2478     +103     
==========================================
+ Hits          441      450       +9     
- Misses       1934     2028      +94     
Files Coverage Δ
reana/reana_dev/git.py 25.35% <8.73%> (-3.69%) ⬇️


@git_commands.command(name="git-aggregate-changelog")
@click.option(
"--previous-reana-client",
Copy link
Member

Choose a reason for hiding this comment

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

We could enrich the CLI later so that users could pass -c as to the other reana-dev commands. This might be useful to generate quickly an overview of all the changes from version X to version Y for example.

Such a CLI interface could look something like:

-c r-client -- since-version 0.9.2
-c r-client --since-date=2023-01-01

Or, by analogy with git-checkout-pr, we should probably have a tuple of values to allow assembling several components:

-b r-client 0.9.1 -b r-j-controller 0.9.0 

Just some wild musings for later, not for now.

That said, if we do decide to go for this one day, to allow aggregating news from more than one release, then the CLI option name could change, so perhaps we could forward-name the option to be something like --since-reana-client-version 0.9.2 instead of --previous-reana-client? 🤔

"for the last REANA release?",
required=True,
)
def get_aggregate_changelog(previous_reana_client): # noqa: D301
Copy link
Member

Choose a reason for hiding this comment

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

Works nicely 👍

One functionality comment that would be good to do already now is to present the aggregation of components following their alphabetical naming order, so that the order is predictible.

(Currently I'm seeing r-w-e-yadage being printed before r-w-e-snakemake for example.)

mdonadoni added a commit to mdonadoni/reana that referenced this pull request Mar 13, 2024
mdonadoni added a commit to mdonadoni/reana that referenced this pull request Mar 13, 2024
@mdonadoni mdonadoni merged commit 6210b11 into reanahub:master Mar 13, 2024
15 checks passed
@mdonadoni mdonadoni deleted the aggregate-changes branch March 13, 2024 12:50
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