feat: Guided Tour - Secrets#2406
Draft
camielvs wants to merge 2 commits into
Draft
Conversation
🎩 PreviewA preview build has been created at: |
This was referenced Jun 10, 2026
Collaborator
Author
3 tasks
camielvs
force-pushed
the
06-10-feat_guided_tour_-_secrets
branch
3 times, most recently
from
4588433 to
9700273
Compare
camielvs
force-pushed
the
06-10-feat_guided_tours_framework_secrets_
branch
2 times, most recently
from
62653bf to
d7a841f
Compare
camielvs
force-pushed
the
06-10-feat_guided_tour_-_secrets
branch
from
9700273 to
52e59d0
Compare
camielvs
force-pushed
the
06-10-feat_guided_tours_framework_secrets_
branch
from
d7a841f to
c7356f5
Compare
camielvs
force-pushed
the
06-10-feat_guided_tour_-_secrets
branch
from
52e59d0 to
61e99a7
Compare
This was referenced Jun 12, 2026
Set mockBackend on the Secrets tour so it runs hands-on without a real backend (secrets mocked in-memory), and reword the final step so it reads correctly whether or not a run is actually submitted. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
camielvs
force-pushed
the
06-10-feat_guided_tour_-_secrets
branch
from
61e99a7 to
e5de95e
Compare
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The registered Using Secrets guided tour — a 12-step walkthrough of why credentials don't belong in a pipeline, what secrets are, and the two ways to attach one. Uses the secret interaction mechanics, the in-editor Settings stand-in, and the in-memory mock backend from #2405, and boots into a small
Secretstour pipeline that makes an authenticated HTTP request.The tour covers the whole lifecycle: the problem → what a secret is → create one and bind it to a task argument → manage secrets in an in-editor Settings → Secrets stand-in → then the alternative: bind a secret to a pipeline input at submit time.
It runs hands-on with or without a backend: it sets
mockBackend: true, so when no real backend is available the secret steps work against the in-memory mock from #2405 (ephemeral, never leaves the browser); with a backend they use the real secrets API. Either way the steps gate normally.What's in the tour
select-task)tokenargument's ⚡ menu → Dynamic Data → Select Secret (open-secret-dialog)assign-secret-argument)tokenargument now shows the secret by name, with a lock icon (context panel)open-settings-panel)open-submit-dialog)assign-secret-submit)API_KEYinput is now backed by the secret; with a backend you can Submit Run, then finish (the copy reads correctly whether or not a real run is launched)DOM anchors & assets added in this PR
Following the convention that tour-specific anchors ship with the tour:
mockBackend: trueon the tour definition — opts the Secrets tour into the in-memory mock backend (from feat: Guided Tours Framework (Secrets) #2405) when no real backend is available.public/tour-pipelines/Secrets.pipeline.component.yaml(Secrets: anAuthenticated Requesttask taking atokenand anapi_key, wired to an emptyAPI_KEYinput, plus aShow Responseecho task).ThunderMenu—data-tour="thunder-menu-content";DynamicDataSubmenu—data-tour="thunder-menu-submenu-content"(so the ⚡ menu and its submenu can be spotlit together).SubmitTaskArgumentsDialog—data-tour="submit-arguments-dialog"anddata-tour="submit-arguments-confirm".Interactions consumed (defined in #2405):
select-task,open-secret-dialog,assign-secret-argument,open-settings-panel,open-submit-dialog,assign-secret-submit. Theusing-secretsLearning Hub entry was already registered lower in the stack, so notours.json/FeaturedTourschange is needed here.Related Issue and Pull requests
Progresses https://github.com/Shopify/oasis-frontend/issues/583
Depends on #2405 (secret interaction mechanics, in-editor Settings stand-in, and the in-memory mock backend) and the framework stack below it.
Type of Change
Checklist
Test Instructions
Start the Using Secrets tour from the Learning Hub and walk all 12 steps.
With a backend (configured + authorized for the secrets API):
tokenargument should end up showing the secret name, not a value.API_KEYin the submit dialog; step 12's Submit Run is enabled and Finish Tour is clickable while the dialog is open.Without a backend (mock path):
/api/secretscalls fire.Screenshots