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

Restructure cli commands #4467

Merged
merged 8 commits into from
Nov 28, 2024
Merged

Restructure cli commands #4467

merged 8 commits into from
Nov 28, 2024

Conversation

xoxys
Copy link
Member

@xoxys xoxys commented Nov 26, 2024

Fixes: #3866

Personally, I would keep the pipeline command at the top-level but open for other suggestions. What do you think about sorting commands alphabetically? To me, the current command order looks a bit random.

@xoxys xoxys requested a review from a team November 26, 2024 21:38
@xoxys xoxys added enhancement improve existing features breaking will break existing installations if no manual action happens cli labels Nov 26, 2024
@xoxys xoxys added this to the 3.0.0 milestone Nov 26, 2024
@woodpecker-bot
Copy link
Contributor

woodpecker-bot commented Nov 26, 2024

Deployment of preview was torn down

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

Attention: Patch coverage is 0% with 249 lines in your changes missing coverage. Please review.

Project coverage is 28.07%. Comparing base (6f7f769) to head (19b7777).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
cli/org/secret/secret_list.go 0.00% 29 Missing ⚠️
cli/repo/secret/secret_list.go 0.00% 29 Missing ⚠️
cli/org/secret/secret_add.go 0.00% 27 Missing ⚠️
cli/org/secret/secret_info.go 0.00% 26 Missing ⚠️
cli/org/secret/secret_set.go 0.00% 24 Missing ⚠️
cli/admin/secret/secret_add.go 0.00% 23 Missing ⚠️
cli/admin/secret/secret_info.go 0.00% 22 Missing ⚠️
cli/admin/secret/secret_set.go 0.00% 20 Missing ⚠️
cli/org/secret/secret.go 0.00% 17 Missing ⚠️
cli/org/secret/secret_rm.go 0.00% 12 Missing ⚠️
... and 7 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4467      +/-   ##
==========================================
- Coverage   28.22%   28.07%   -0.16%     
==========================================
  Files         385      396      +11     
  Lines       27847    28001     +154     
==========================================
  Hits         7860     7860              
- Misses      19296    19450     +154     
  Partials      691      691              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@xoxys xoxys force-pushed the restructure-cli-commands branch from 1ba8ec4 to 6fac7ed Compare November 27, 2024 07:19
@xoxys xoxys requested a review from qwerty287 November 28, 2024 15:05
@xoxys xoxys merged commit d4c0178 into main Nov 28, 2024
6 of 7 checks passed
@xoxys xoxys deleted the restructure-cli-commands branch November 28, 2024 17:25
@woodpecker-bot woodpecker-bot mentioned this pull request Nov 28, 2024
1 task
@anbraten
Copy link
Member

Could you add a migration instruction / hint to the docs?

@xoxys
Copy link
Member Author

xoxys commented Nov 28, 2024

Could you add a migration instruction / hint to the docs?

Sure but what do you have in mind? The new structure is covered by the docs and the change itself is listed as breaking change in the release notes already.

@anbraten
Copy link
Member

anbraten commented Nov 28, 2024

I would suggest adding something like to https://woodpecker-ci.org/migrations#user-migrations

Some cli commands got restructured to provide a simplified structure. Use:
- `cli secret --global ...` is now `cli admin secret ...`
- `cli secret --org ...` is now `cli org secret ...`
- ...

My goal before releasing 3.0 would be to have a migration list a user / admin could easily follow like a manual.

@xoxys
Copy link
Member Author

xoxys commented Nov 28, 2024

OK. IMO that's a bit overkill and frankly very tedious, but I can look into it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking will break existing installations if no manual action happens cli enhancement improve existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restructure cli commands
4 participants