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

chore: add a task summarize #29893

Merged
merged 1 commit into from
Dec 13, 2024
Merged

chore: add a task summarize #29893

merged 1 commit into from
Dec 13, 2024

Conversation

suzuki-shunsuke
Copy link
Member

@suzuki-shunsuke suzuki-shunsuke commented Dec 13, 2024

This pull request add a cmdx task summarize, outputting a summary of a give pull request.
For now, the feature of this task is very simple but enough.
This task outputs a list of changed packages.

e.g.

$ cmdx sum 29826
+ bash scripts/summarize.sh "$PR_NUMBER"

[gardener/docforge](https://github.com/gardener/docforge) - Scalable build tool for distributed documentation sources

We assume that we run this command at our laptops and paste the result to the pull request description.

Why is this task necessary?

We provide a task new, creating a pull request to add packages.

cmdx new

This task is useful, but it has a problem that it doesn't work well if users don't have the permission to push a commit to origin.

We tried to resolve this issue, but it's a bit hard because this depends on user's environment.

So we changed the mind.
Users would be able to create a pull request easily without cmdx new.
The benefit of cmdx new is to give a good description.
The description is for maintainers mainly.
We decided to abandon cmdx new and complement the benefit by adding a new task creating a good description.
The maintainer can run the task at their laptops.
Maintainers can resolve issues regarding their environment themselves.

TODO

  • Update the contribution guide

@suzuki-shunsuke suzuki-shunsuke merged commit 861d99b into main Dec 13, 2024
16 checks passed
@suzuki-shunsuke suzuki-shunsuke deleted the chore-add-summarize branch December 13, 2024 04:54
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.

1 participant