Feat/example tutorial and sync #258
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,105 @@ | ||||||||||||||||||
| name: Docs Sync → cosmos/example | ||||||||||||||||||
|
|
||||||||||||||||||
| # Runs when example tutorial .mdx files change on main. | ||||||||||||||||||
| # Transforms .mdx → .md and opens a PR on the example repo. | ||||||||||||||||||
| # If a sync PR is already open, updates it instead of opening a new one. | ||||||||||||||||||
| # Skip if the commit was itself produced by the sync (loop guard). | ||||||||||||||||||
|
|
||||||||||||||||||
| on: | ||||||||||||||||||
| push: | ||||||||||||||||||
| branches: | ||||||||||||||||||
| - main | ||||||||||||||||||
| paths: | ||||||||||||||||||
| - "sdk/next/tutorials/example/**" | ||||||||||||||||||
|
|
||||||||||||||||||
| jobs: | ||||||||||||||||||
| sync: | ||||||||||||||||||
| name: Sync example tutorials to cosmos/example | ||||||||||||||||||
| runs-on: ubuntu-latest | ||||||||||||||||||
| # Loop guard: skip commits that the docs-sync bot created | ||||||||||||||||||
| if: "!contains(github.event.head_commit.message, '[docs-sync]')" | ||||||||||||||||||
|
|
||||||||||||||||||
| steps: | ||||||||||||||||||
| - name: Checkout cosmos/docs | ||||||||||||||||||
| uses: actions/checkout@v4 | ||||||||||||||||||
|
|
||||||||||||||||||
| - name: Set up Python | ||||||||||||||||||
| uses: actions/setup-python@v5 | ||||||||||||||||||
| with: | ||||||||||||||||||
| python-version: "3.12" | ||||||||||||||||||
|
|
||||||||||||||||||
| - name: Checkout cosmos/example | ||||||||||||||||||
| uses: actions/checkout@v4 | ||||||||||||||||||
| with: | ||||||||||||||||||
| repository: cosmos/example | ||||||||||||||||||
| # Fine-grained PAT with contents:write and pull-requests:write on cosmos/example | ||||||||||||||||||
| token: ${{ secrets.EXAMPLE_REPO_TOKEN }} | ||||||||||||||||||
| path: cosmos-example | ||||||||||||||||||
|
|
||||||||||||||||||
| - name: Transform Mintlify → example repo format | ||||||||||||||||||
| run: | | ||||||||||||||||||
| python3 scripts/docs-sync/transform.py \ | ||||||||||||||||||
| --direction to-example \ | ||||||||||||||||||
| --input sdk/next/tutorials/example/ \ | ||||||||||||||||||
| --output-dir cosmos-example/docs/ | ||||||||||||||||||
|
|
||||||||||||||||||
| - name: Check for changes | ||||||||||||||||||
| id: diff | ||||||||||||||||||
| run: | | ||||||||||||||||||
| cd cosmos-example | ||||||||||||||||||
| [ -n "$(git status --porcelain docs/)" ] \ | ||||||||||||||||||
| && echo "changed=true" >> "$GITHUB_OUTPUT" \ | ||||||||||||||||||
| || echo "changed=false" >> "$GITHUB_OUTPUT" | ||||||||||||||||||
|
|
||||||||||||||||||
| - name: Open or update PR on cosmos/example | ||||||||||||||||||
| if: steps.diff.outputs.changed == 'true' | ||||||||||||||||||
| env: | ||||||||||||||||||
| GH_TOKEN: ${{ secrets.EXAMPLE_REPO_TOKEN }} | ||||||||||||||||||
| run: | | ||||||||||||||||||
| cd cosmos-example | ||||||||||||||||||
|
|
||||||||||||||||||
| git config user.name "docs-sync[bot]" | ||||||||||||||||||
| git config user.email "docs-sync[bot]@users.noreply.github.com" | ||||||||||||||||||
|
|
||||||||||||||||||
| # Check for an existing open sync PR | ||||||||||||||||||
| EXISTING=$(gh pr list \ | ||||||||||||||||||
| --repo cosmos/example \ | ||||||||||||||||||
| --label "docs-sync" \ | ||||||||||||||||||
| --state open \ | ||||||||||||||||||
| --json number,headRefName \ | ||||||||||||||||||
| --jq '.[0]') | ||||||||||||||||||
|
|
||||||||||||||||||
| if [ -n "$EXISTING" ]; then | ||||||||||||||||||
| PR_NUMBER=$(echo "$EXISTING" | jq -r '.number') | ||||||||||||||||||
| BRANCH=$(echo "$EXISTING" | jq -r '.headRefName') | ||||||||||||||||||
|
|
||||||||||||||||||
| # Stash the transform output before switching branches, | ||||||||||||||||||
| # then restore it on top of the existing sync branch. | ||||||||||||||||||
| git stash | ||||||||||||||||||
| git fetch origin "$BRANCH" | ||||||||||||||||||
| git checkout "$BRANCH" | ||||||||||||||||||
| git stash pop | ||||||||||||||||||
| git add docs/ | ||||||||||||||||||
| git commit -m "docs: sync example tutorials from cosmos/docs [docs-sync]" | ||||||||||||||||||
| git push origin "$BRANCH" | ||||||||||||||||||
|
|
||||||||||||||||||
| gh pr comment "$PR_NUMBER" \ | ||||||||||||||||||
| --repo cosmos/example \ | ||||||||||||||||||
|
Comment on lines
+84
to
+87
Contributor
There was a problem hiding this comment.
The fix is to include untracked files in the stash:
Suggested change
Using |
||||||||||||||||||
| --body "Sync updated: cosmos/docs was updated before this PR merged. Branch has been refreshed — please re-review." | ||||||||||||||||||
| echo "Updated existing PR #$PR_NUMBER" | ||||||||||||||||||
|
|
||||||||||||||||||
| else | ||||||||||||||||||
| BRANCH="docs-sync/from-docs-$(date +%Y%m%d-%H%M%S)" | ||||||||||||||||||
| git checkout -b "$BRANCH" | ||||||||||||||||||
| git add docs/ | ||||||||||||||||||
| git commit -m "docs: sync example tutorials from cosmos/docs [docs-sync]" | ||||||||||||||||||
| git push origin "$BRANCH" | ||||||||||||||||||
|
evanorti marked this conversation as resolved.
|
||||||||||||||||||
|
|
||||||||||||||||||
| gh pr create \ | ||||||||||||||||||
| --repo cosmos/example \ | ||||||||||||||||||
| --head "$BRANCH" \ | ||||||||||||||||||
| --base main \ | ||||||||||||||||||
| --title "docs: sync example tutorials from cosmos/docs" \ | ||||||||||||||||||
| --label "docs-sync" \ | ||||||||||||||||||
| --body "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." | ||||||||||||||||||
| fi | ||||||||||||||||||
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.