Skip to content

docs: sync example tutorials from cosmos/docs - #9

Open
evanorti wants to merge 3 commits into
mainfrom
docs-sync/from-docs-20260331-201200
Open

docs: sync example tutorials from cosmos/docs#9
evanorti wants to merge 3 commits into
mainfrom
docs-sync/from-docs-20260331-201200

Conversation

@evanorti

Copy link
Copy Markdown
Collaborator

Auto-synced from cosmos/docs. Transforms sdk/next/tutorials/example/.mdx to docs/.md. Do not edit docs/ files directly in cosmos/example — edit the source and let the sync bot update them.

@evanorti evanorti added the docs-sync Automated docs sync PR label Mar 31, 2026
@evanorti

evanorti commented Apr 1, 2026

Copy link
Copy Markdown
Collaborator Author

Sync updated: cosmos/docs was updated before this PR merged. Branch has been refreshed — please re-review.

evanorti added a commit to cosmos/docs that referenced this pull request Aug 25, 2026
… runs (#343)

Mirrors cosmos/example#16 and #17 in the reverse direction.

The workflow transformed the tutorials into cosmos-example/ while still on main,
then stashed, switched to the open sync branch, and popped. Popping a stash
taken against main onto a branch that already carries overlapping changes
conflicts and exits 1, which fails the step under bash -e. That is the likely
cause of the unexplained 2026-04-10 failure, which ran while cosmos/example#9
had been open since March 31.

Select the target branch and check it out first, while the tree is still clean,
then transform directly onto it. Nothing is stashed and nothing is merged, so
there is no conflict to hit. Replaces the separate change-detection step with a
`git diff --cached --quiet` guard so an up-to-date branch exits cleanly instead
of creating an empty commit.

Also adds a concurrency group, so two overlapping runs cannot derive divergent
commits from the same branch revision and race on push, and workflow_dispatch,
so a sync PR left stale by a failed run can be brought current without waiting
for the next docs edit.

Verified against real clones of cosmos/docs and cosmos/example using the stale
cosmos/example#9 branch: with the transform output overlapping lines that branch
already changed, the old sequence produces "CONFLICT (content): Merge conflict
in docs/02-quickstart.md" and exits 1, while the new sequence exits 0 and stages
the correct refresh.
@evanorti

Copy link
Copy Markdown
Collaborator Author

Sync updated: cosmos/docs was updated before this PR merged. Branch has been refreshed, please re-review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-sync Automated docs sync PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant