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

fix(reana-dev): create commits that conform to conventional style (#777) #777

Merged
merged 1 commit into from
Feb 16, 2024

Conversation

mdonadoni
Copy link
Member

No description provided.

Copy link

codecov bot commented Feb 8, 2024

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (43ead8a) 18.61% compared to head (86d0133) 18.63%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #777      +/-   ##
==========================================
+ Coverage   18.61%   18.63%   +0.01%     
==========================================
  Files          26       26              
  Lines        2326     2345      +19     
==========================================
+ Hits          433      437       +4     
- Misses       1893     1908      +15     
Files Coverage Δ
reana/config.py 100.00% <100.00%> (ø)
reana/reana_dev/git.py 29.13% <0.00%> (-0.13%) ⬇️
reana/reana_dev/utils.py 37.15% <13.33%> (-0.93%) ⬇️

@@ -1365,7 +1371,8 @@ def git_upgrade_requirements(ctx, component, exclude_components): # noqa: D301
if upgrade_requirements(component):
run_command(f"git add {PYTHON_REQUIREMENTS_FILE}", component)
run_command(
'git commit -m "installation: bump all dependencies"', component
f'git commit -m "build(deps): bump all dependencies{get_commit_pr_suffix(component)}"',
Copy link
Member

Choose a reason for hiding this comment

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

build(python) perhaps, so that we restrict the meaning of "all" here? (alternatively, we could use "bump all Python packages")

@@ -1280,7 +1286,7 @@ def git_upgrade_shared_modules(

def _create_commit_or_amend(components):
for c in components:
commit_cmd = 'git commit -m "installation: bump shared modules"'
commit_cmd = f'git commit -m "build(deps): bump shared modules{get_commit_pr_suffix(component)}"'
Copy link
Member

Choose a reason for hiding this comment

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

build(python) perhaps, by analogy with build(docker) and friends?

@@ -199,8 +201,11 @@ def git_create_release_commit(
if modified_files:
run_command(f"git add {' '.join(modified_files)}", component)

commit_msg = (
f"chore({base}): release {next_version}{get_commit_pr_suffix(component)}"
Copy link
Member

Choose a reason for hiding this comment

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

BTW one meta comment related to the release news.

Currently this PR would advertise:

fix(reana-dev): create commits that conform to conventional style

This does not expose the reana-dev sub commands that this change improves.

If we would like to include those (for analogy with #765), perhaps the commit should be split in two, advertising something like:

fix(reana-dev): `git-create-release-commit` use conventional commit style
fix(reana-dev): `git-upgrade-shared-modules` use conventional commit style

But we are probably hitting the line length limits here...

Copy link
Member Author

Choose a reason for hiding this comment

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

From my point of view this was a "general" change to the whole reana-dev to conform to the conventional commit style we have agreed on. Not sure how to also include the name of the command in the commit title while also staying under the character limit, unfortunately.

@tiborsimko tiborsimko merged commit 86d0133 into reanahub:master Feb 16, 2024
15 checks passed
@mdonadoni mdonadoni deleted the fix-conventional-commits branch February 28, 2024 13:42
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