chore: Add GitHub workflow to sync public API docs (no-changelog) #15985
+110
−1
Conversation
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
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
cubic found 3 issues across 2 files. Review them in cubic.dev
React with 👍 or 👎 to teach cubic. Tag @cubic-dev-ai to give specific feedback.
|
|
||
| # TODO: Check this | ||
| # The token needs write access to the docs repository to push branches and create PRs | ||
| token: ${{ secrets.GITHUB_TOKEN }} |
There was a problem hiding this comment.
Default GITHUB_TOKEN lacks permissions to create PRs in external repositories
Suggested change
| token: ${{ secrets.GITHUB_TOKEN }} | |
| token: ${{ secrets.DOCS_REPO_PAT }} |
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
n8n-assistant
bot
added
core
MarcL
force-pushed
the
marcl/sync-public-api-docs
branch
from
055bdbb to
4cfc1d2
Compare
MarcL
commented
Jun 5, 2025
MarcL
force-pushed
the
marcl/sync-public-api-docs
branch
from
4cfc1d2 to
163b83b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
When merging #12329 I found out that the public API OpenAPI schema is not synced with the n8n-io/n8n-docs repo.
This PR adds a GitHub workflow to sync any changes to the schema and raise a PR in the docs repo when a PR is merged to
master.Related Linear tickets, Github issues, and Community forum posts
Related: #15969
Review / Merge checklist
[ ] Docs updated or follow-up ticket created.[ ] Tests included.[ ] PR Labeled withrelease/backport(if the PR is an urgent fix that needs to be backported)