docs: rewrite GitHub integration page as step-by-step tutorial#2512
docs: rewrite GitHub integration page as step-by-step tutorial#2512marcel-rbro wants to merge 1 commit into
Conversation
…utorial Restructures the GitHub integration page into prerequisites, a numbered "Create an Actor from a GitHub repository" walkthrough that matches the current "Let's build a new Actor!" UI, and a written tutorial for opening a GitHub issue via Apify webhook + the GitHub REST API. Replaces the bare YouTube embed and refreshes the new-Actor and Integrations-tab screenshots. Closes #2492 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
marcel-rbro
changed the title
|
|
||
| ## Build automatically on every push | ||
|
|
||
| {/* REVIEWER QUESTION: The "Link a Git repository" panel says "set Apify to automatically build the Actor on changes", which suggests the native GitHub flow above already wires up auto-builds on push. If so, the manual GitHub webhook recipe below is now the legacy/advanced path. Please confirm the current behavior and let me know whether to (a) keep the manual recipe as-is, (b) replace it with a one-line note + link to CI for Actors, or (c) keep both with a short "the flow above already triggers builds; use this for finer control" intro. */} |
There was a problem hiding this comment.
No, unfortunately, right now, it does not work that way. You still need to setup webhook manually. We are working on improvements, but for now, let's describe it correctly -> so (a) keep the manual recipe as-is.
|
Also, it would be great to have preview to check it. :) Anyway, thanks! It looks good. |
|
Previews are broken atm (seems connected to npm > pnpm migraton) @vladfrangu is aware and working on fix |
|
I'm gonna piggy back off of this PR to test out the fixed previews, pls stand by and sorry in advance |
|
✅ Preview for this PR (commit |
|
One note -> let's probably remove the video? cc. @TC-MO |
|
Yes, I'll never say no to video pruning from docs :D how urgent this is? Can it wait until Marcel is back from off time next week, or should I take over to have this shipped this week? |
|
I guess it can wait, we are refactoring the UI in the meantime, so maybe it will need to be updated. :D |
5 participants
Closes #2492
Summary
Rewrites
sources/platform/integrations/programming/github.md:ACTOR.RUN.FAILEDHTTP webhook on the Actor, set the headers/payload templates to callPOST /repos/{owner}/{repo}/issues, save and test. Kept the original video as a "Video walkthrough" subsection.apify-git-repository.png(the new-Actor page) andintegrations-tab.png(the Add integration page; this image is also reused byslack.mdandwebhooks/index.md).apify-git-provider-select.png(the provider-picker modal no longer exists).<ThirdPartyDisclaimer />, no bold one-liner or---rule), matching recent integration pages (Pipedream, Snowflake, Manus, viaSocket, x402).Reviewer question
There's an inline MDX comment in the Build automatically on every push section asking whether the native "Link a Git repository" flow already wires up auto-builds (the panel's helper text suggests it does). If so, the manual GitHub webhook recipe currently in that section is the legacy path - please confirm and let me know whether to keep it as-is, replace it with a one-line note, or keep both with a clarifying intro.
Test plan
pnpm lint:mdpasses for the changed filevale "sources/platform/integrations/programming/github.md"reports 0 errors/platform/actors/development/deployment/continuous-integration,/platform/actors/development/deployment/source-types#private-repositories,/platform/integrations/webhooks/events,/platform/integrations/webhooks/actions)pnpm buildpasses (no broken links, frontmatter valid)integrations-tab.pngcorrectly🤖 Generated with Claude Code