Repository navigation
Release the B2B Manage sample and give every sample README the same structure - #13
Open
brionmario wants to merge 2 commits into
Open
brionmario wants to merge 2 commits into
brionmario wants to merge 2 commits into
Conversation
Signed-off-by: Brion <info@brionmario.com>
Each README now has the same sections in the same order: prerequisites, getting the sample, configuring, running, any sample-specific sections, learn more, and license. AGENTS.md documents that structure and asks for every new sample to be added to the release workflow. Signed-off-by: Brion <info@brionmario.com>
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
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.
Purpose
Makes the B2B Manage sample releasable, and gives every sample README the same structure.
Approach
Release workflow
sample_b2b_manageinput torelease.yml, plus its line in the Plan Releases step. The workflow now has 16 of the 25 inputsworkflow_dispatchallows.READMEs
All 14 sample READMEs now follow one pattern:
#title that matches the banner's alt text## Prerequisites, with minimum versions and the ThunderID server## Get the sample, with the sample's filtered releases link andnpx degit## Configure, with the Console template to pick and a table of every variable in the config template## Run## Learn more, linking the docs quickstart guide and the SDK reference## LicenseAlong the way:
.env.exampleand config templates, includingNODE_TLS_REJECT_UNAUTHORIZEDand the optionalTHUNDERID_SCOPE.v1.0.x/sdks/...links only reached a redirect page.AGENTS.md
release.yml, all three parts, in the same pull request.Related Issues
Related PRs
Checklist
breaking changelabel added.Security checks