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

Improve commit messagges from the core service #2152

Closed
1 of 2 tasks
lorenzo-cavazzi opened this issue Jun 10, 2021 · 0 comments · Fixed by #2234
Closed
1 of 2 tasks

Improve commit messagges from the core service #2152

lorenzo-cavazzi opened this issue Jun 10, 2021 · 0 comments · Fixed by #2234
Assignees

Comments

@lorenzo-cavazzi
Copy link
Member

lorenzo-cavazzi commented Jun 10, 2021

Is your improvement request related to a use case or a component design? Please describe.
While using the new config APIs, I've noticed the commit messages created by the core service are a bit cryptic. Specifically, I see:

gunicorn renku.service.entrypoint:app --preload -b 0.0.0.0:8080 --timeout 600 --workers 4 --worke...

For a user, it may be unclear what happened.
It would be nice to have something similar to other APIs, where the message includes the cli equivalent command, like templates.create_project

service: renku init -n "project-config" -s "https://github.com/SwissDataScienceCenter/renku-proje...

Proposal
Having a standard for the commit messages would be great. For the APIs, it could be something like:

  • First line: scope (E.G. renku service - update config, renku service - create project)
  • Second and following lines: cli equivalent command, or other relevant information to re-run the command where the command is not meaningful (E.G. renku init -n "project-config" -s "https://github.com [...]", renku config set [...]). Do not cut the renku command, or do that only when the number of chars is very high -- currently, it's a bit low

Update
Scope of the issue:

@lorenzo-cavazzi lorenzo-cavazzi self-assigned this Jul 26, 2021
lorenzo-cavazzi added a commit that referenced this issue Aug 3, 2021
Allow writing longer commit messages that are wrapped and trimmed.

re #2152
lorenzo-cavazzi added a commit that referenced this issue Aug 6, 2021
Allow writing longer commit messages that are wrapped and trimmed.

re #2152
lorenzo-cavazzi added a commit to lorenzo-cavazzi/renku-python that referenced this issue Aug 9, 2021
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 a pull request may close this issue.

1 participant