Add workflow to trigger docs-internal SDK sync on docs changes#1461
Draft
sunbrye wants to merge 1 commit into
Draft
Add workflow to trigger docs-internal SDK sync on docs changes#1461sunbrye wants to merge 1 commit into
sunbrye wants to merge 1 commit into
Conversation
When docs/ files change on main, this workflow dispatches a repository_dispatch event to github/docs-internal, which triggers the Copilot SDK docs sync pipeline. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+14
to
+30
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Dispatch sync to docs-internal | ||
| uses: peter-evans/repository-dispatch@v3 | ||
| with: | ||
| # TODO: Create a repository secret named DOCS_INTERNAL_PAT | ||
| # with a PAT that has contents:write access to github/docs-internal. | ||
| # Alternatively, use a GitHub App token for better security | ||
| # (see: actions/create-github-app-token@v1). | ||
| token: ${{ secrets.DOCS_INTERNAL_PAT }} | ||
| repository: github/docs-internal | ||
| event-type: sync-sdk-docs | ||
| client-payload: >- | ||
| { | ||
| "ref": "${{ github.sha }}", | ||
| "sender": "${{ github.actor }}" | ||
| } |
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
2 participants
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.
GitHub Copilot generated this pull request.
Summary
Adds a GitHub Actions workflow that automatically triggers the docs-internal SDK sync pipeline whenever files in
docs/change onmain.How it works
mainthat touchesdocs/**triggers this workflowrepository_dispatchevent (type:sync-sdk-docs) togithub/docs-internalSetup needed
Related