-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
docs(flag): add UseShortOptionHandling
description
#1953
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. However, the documentation website https://cli.urfave.org/ is still built using the docs
folder of v2-maint
branch so this change won't be reflected on the website.
@dearchap @meatballhat Should we consider moving the publish
job from v2-maint
branch to main
branch?
Lines 71 to 88 in a4832fd
publish: | |
permissions: | |
contents: write | |
if: startswith(github.ref, 'refs/tags/') | |
name: publish | |
needs: [test-docs] | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- run: make ensure-mkdocs | |
env: | |
FLAGS: --upgrade-pip | |
- run: make set-mkdocs-remote | |
env: | |
MKDOCS_REMOTE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
- run: make deploy-mkdocs |
@junezee you mean this one? cli/.github/workflows/test.yml Lines 89 to 96 in 937cfe9
|
I would say, docs publishing needs a separate job, which will pull markup files from all branches. This way |
This may not be a good idea because the current main branch contains the documentation for v3, which is still in the alpha stage. If we change it to the I think we can merge this PR first, as the current changes include |
85ac7ff
to
f89808d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for contributing! 🎉
Close: urfave#1942 Signed-off-by: Kevin Cui <bh@bugs.cc>
Co-authored-by: Anatoli Babenia <anatoli@rainforce.org>
Co-authored-by: Anatoli Babenia <anatoli@rainforce.org>
What type of PR is this?
What this PR does / why we need it:
Add a description of
UseShortOptionHandling
in the Flag section so that users can clearly understand that to support Flags like-vvv
, it is necessary to setUseShortOptionHandling
.Which issue(s) this PR fixes:
Close: #1942
Special notes for your reviewer:
nil
Testing
nil
Release Notes