Skip to content

chore(docs): update CI/CD docs for standard vs composable split#174

Open
arrowplum wants to merge 1 commit intomainfrom
chore/update-docs-for-standard
Open

chore(docs): update CI/CD docs for standard vs composable split#174
arrowplum wants to merge 1 commit intomainfrom
chore/update-docs-for-standard

Conversation

@arrowplum
Copy link
Contributor

Summary

Restructures the CI/CD documentation into two clear paths: a "standard" guide (CICD-standard.md) for the recommended orchestrated workflows, and a "composable" guide (CICD-with-shared-actions.md) for teams that need fine-grained control over individual pipeline stages. Version references are updated from v2.0.3 to v3.2.0 throughout.

The standard doc now leads with a mermaid sequence diagram and includes a full combined example (artifacts + docker + release bundle). The composable doc is repositioned as the "eject" path with detailed manual composition examples showing how jf-build-id and artifact names must align between stages.

Changes

  • Split docs into standard (orchestrated) vs composable (eject) paths with clear cross-references
  • Added mermaid sequence diagram and combined pipeline example to CICD-standard.md
  • Added full composable pipeline examples with key alignment notes (build IDs, artifact names)
  • Updated all version references from v2.0.3 to v3.2.0
  • Minor formatting fixes and troubleshooting clarifications

Test plan

Docs-only change - no functional impact.

@arrowplum arrowplum requested a review from a team as a code owner March 14, 2026 01:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant