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

Fix wrong extension reference on WebauthN documentation #29688

Merged
merged 1 commit into from
Dec 6, 2022
Merged

Fix wrong extension reference on WebauthN documentation #29688

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/security-webauthn.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The solution is located in the `security-webauthn-quickstart` {quickstarts-tree-
First, we need a new project. Create a new project with the following command:

:create-app-artifact-id: security-webauthn-quickstart
:create-app-extensions: security-webauthn,reactive-pg-client,resteasy-reactive,hibernate-reactive-panache,test-security-webauthn
:create-app-extensions: security-webauthn,reactive-pg-client,resteasy-reactive,hibernate-reactive-panache
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you tested if this actually adds the library or if it ignores it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is throwing an error!

quarkus create app org.acme:security-webauthn-quickstart \
    --extension='security-webauthn,reactive-pg-client,resteasy-reactive,hibernate-reactive-panache,test-security-webauthn' \
    --no-code
Looking for the newly published extensions in registry.quarkus.io
[ERROR] ❗  Cannot find a dependency matching 'test-security-webauthn', maybe a typo?
[ERROR] ❗  Unable to create project: Failed to create project because of invalid extensions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same if you try to add the library later on:

quarkus extension add 'test-security-webauthn'
[ERROR] ❗  Nothing installed because keyword(s) 'test-security-webauthn' were not matched in the catalog.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but... I like your idea of ignore those dependencies that are not in the catalog!. Maybe if an extension is not in the catalog we could just write a warning message but create the app with those deps that are right.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you try adding quarkus-test-security-webauthn instead?

I think it's better to keep it an error so if not working at all, I will merge your patch.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you try adding quarkus-test-security-webauthn instead?

Same issue with quarkus-test-security-webauthn

include::{includes}/devtools/create-app.adoc[]

[NOTE]
Expand Down Expand Up @@ -1059,7 +1059,7 @@ Quarkus WebAuthn endpoints to defer those calls to the worker pool.
== Testing WebAuthn

Testing WebAuthn can be complicated because normally you need a hardware token, which is why we've made the
`quarkus-test-security-webauthn` extension:
`quarkus-test-security-webauthn` helper library:

[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
.pom.xml
Expand Down