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.

Sign up for GitHub

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

Jump to bottom

[Bug]: document for leaf certificate template contains typo #1051

Closed
zhangyoufu opened this issue Oct 24, 2023 · 1 comment · Fixed by #1052
Closed

[Bug]: document for leaf certificate template contains typo #1051

zhangyoufu opened this issue Oct 24, 2023 · 1 comment · Fixed by #1052
Assignees
@hslatman
Labels
bug needs triage Waiting for discussion / prioritization by team
Milestone
v0.25.1

Comments

@zhangyoufu
Copy link

zhangyoufu commented Oct 24, 2023 •
edited
Loading

Steps to Reproduce

% step help certificate create | grep -F typeIs
          {{- if typeIs "*sa.PublicKey" .Insecure.CR.PublicKey }}
% step help certificate sign | grep -F typeIs
          {{- if typeIs "*sa.PublicKey" .Insecure.CR.PublicKey }}

Your Environment

% step version
Smallstep CLI/0.25.0 (darwin/amd64)
Release Date: 2023-09-27 12:02 UTC

Expected Behavior

The type should be *rsa.PublicKey

Actual Behavior

The output is *sa.PublicKey

Additional Context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).
@zhangyoufu zhangyoufu added bug needs triage Waiting for discussion / prioritization by team labels Oct 24, 2023
hslatman added a commit that referenced this issue Oct 24, 2023
@hslatman
Fix leaf certificate *rsa.PublicKey example
9dc90a4 
As reported in #1051, the
example template printed in the help has `*sa.PublicKey` instead of
`*rsa.PublicKey`. This is likely due to the help text preprocessor.

This commit adds an underscore to `*_rsa.PublicKey`, which tricks
the help text preprocessor into simply printing `*rsa.PublicKey`,
ignoring it to be processed as Markdown.

A better fix might be do change the help text processor, but there
are no tests, and it's used widely, so it's a riskier method for
not too much gain.
@hslatman hslatman mentioned this issue Oct 24, 2023
Merged
@hslatman hslatman linked a pull request Oct 24, 2023 that will close this issue
Fix leaf certificate *rsa.PublicKey example #1052
Merged
@hslatman
Copy link
Member

Hi @zhangyoufu, thank you for reporting this. I've opened a PR: #1052

@hslatman hslatman added this to the v0.25.1 milestone Oct 24, 2023
@hslatman hslatman self-assigned this Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hslatman hslatman

Labels
bug needs triage Waiting for discussion / prioritization by team
Projects
None yet
Milestone
v0.25.1
Development

Successfully merging a pull request may close this issue.

Fix leaf certificate *rsa.PublicKey example smallstep/cli
2 participants
@hslatman @zhangyoufu