docs: add adoption guide - #165
Merged
Merged
Conversation
A narrative journey guide that ties existing reference docs together, covering the mental model, building a pipeline from scratch, migrating an existing pipeline, wiring existing tooling (release-please, goreleaser), and hardening before production. The guide emphasizes that cascade is reusable-workflow-only: every callback must be a workflow_call workflow, and version derivation is conventional-commit-only by design. Signed-off-by: Joshua Temple <joshua.temple@stablekernel.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
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.
Adds an adoption guide (docs/src/content/docs/adoption.md) plus a sidebar entry: the deeper how-to-rebuild-and-migrate-your-workflows walkthrough that the README fit section points toward. Covers the mental model, a from-scratch build, a what-you-have-today to where-it-lives-under-cascade migration mapping, wiring existing tooling (changelog/release callbacks and opt-outs), and a hardening pointer. Complements getting-started rather than duplicating it; all callback-contract details verified against source.