GitHub Actions: add regional API endpoint docs and sync supported/deprecated actions list - #1699
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
mihaisau-snyk
left a comment
There was a problem hiding this comment.
Annotated each edit with a short summary and the relevant Jira ticket for reviewers.
There was a problem hiding this comment.
Stale comment
Staff tech writer review
The technical facts hold up. I verified the regional endpoint behaviors, environment variable mappings, and authentication failure causes against Regional hosting and data residency, and confirmed all links resolve to valid locations. The deprecation list and new action additions cleanly mirror the upstream repository state.
Requesting changes on two structural points and a set of style fixes, all provided as suggestion blocks you can accept in one click.
Structural findings
1. Align link text with target page title and anchor convention.
On line 14 of the GitHub Actions
README.md, the link text reads[Custom API endpoints](regional-api-endpoints.md). The target page title is# Regional API endpoints. Across CI/CD integration docs, Azure Pipelines usesRegional API endpointsboth as page title and link label. UsingCustom API endpointshere introduces an unnecessary terminology discrepancy between the link text and the destination document.2. Standardize troubleshooting section heading.
In
regional-api-endpoints.md, the heading## Troubleshoot regional endpoint errorsis an outlier across the corpus (zero occurrences). The established house pattern is## Troubleshooting, with 14 occurrences corpus-wide. Standardizing to## Troubleshootingmatches sibling integration pages such as the Eclipse, JetBrains, and Visual Studio documentation.Style fixes (folded into the suggestions)
- Added comma after introductory clause · standardized troubleshooting heading to house pattern.
One thing to confirm
⚠️ The new pageregional-api-endpoints.mdwill need an entry added todeveloper-tools/SUMMARY.mdunderGitHub actions for Snyk setup and checking for vulnerabilitiesso that GitBook publishes it in the navigation tree.Sent by Cursor Automation: PR review for User Docs
There was a problem hiding this comment.
AI review
The technical facts hold up. I verified the regional API endpoint configuration against regional-hosting-and-data-residency.md and confirmed 13 related documentation links return 200.
The documentation is user centric and focuses on the tasks the user must complete. The guidance flows from discovery and onboarding to implementation and troubleshooting.
Advising on two style and terminology points, left as suggestions you can accept in one click.
Style fixes (folded into the suggestions)
- Use "visit" instead of "see" for referencing documentation pages.
- Capitalize the Snyk-defined noun Organization.
Corpus verification
I counted headings across the corpus rather than guessing — pulled every H2 heading from all 1,267 pages on docs.snyk.io:
| Heading | Count across all of docs.snyk.io |
|---|---|
Troubleshooting |
14 — established house pattern |
Regional API endpoints |
1 — mirrors Azure Pipelines |
Sent by Cursor Automation: PR review for User Docs
…b Actions (DOCT-2330, DOCT-2331, DOCT-2332)
…s list (DOCT-2330, DOCT-2333)
Co-authored-by: cursor[bot] <206951365+cursor[bot]@users.noreply.github.com>
Cursor and Mihai both flagged that lowercase 'organization' is ambiguous here - it reads as the generic business sense, but this content is specifically about the Snyk Organization product entity (regions are provisioned per-Organization). Per the style guide, Organization is a capitalized Snyk-defined noun; naming it 'Snyk Organization' on first use in each section removes the ambiguity instead of relying on capitalization alone.
2b09b49 to
880b8da
Compare


Summary
Closes out the GitHub Actions docs work tracked under epic DOCT-2329.
Three changes to the GitHub Actions integration docs:
regional-api-endpoints.md, documenting how to set theSNYK_APIenvironment variable to target a non-default Snyk region in a GitHub Actions workflow, plus troubleshooting for the authentication errors this causes when misconfigured. Mirrors the existing Azure Pipelines "Regional API endpoints" page for consistency across CI/CD integration docs. (DOCT-2330, DOCT-2331, DOCT-2332)snyk/actions(dotNET, five Gradle JDK variants, three Python variants, Scala) and was missing 15 actions that repo now supports (Elixir-1.18, six Gradle JDK17/21/24 variants, three Maven JDK17/21/24 variants, four Python 3.9–3.12 variants, SBT1.10.0-Scala3.4.2). This diff was verified directly against thesnyk/actionsrepo README. (DOCT-2333)Notes for reviewers
Note
Low Risk
Documentation-only changes to GitHub Actions integration guides; no application or security logic is modified.
Overview
Adds GitHub Actions documentation for non-default Snyk regions and brings the supported-action inventory in line with
snyk/actions.A new Regional API endpoints page explains setting
SNYK_APIin workflows (with a YAML example), links to regional hosting docs, and adds troubleshooting for region/token mismatches (including SNYK-US-02 vs default). The page is linked from the main GitHub Actions README and added toSUMMARY.md, aligned with the existing Azure Pipelines regional page.The GitHub Actions README supported actions list is refreshed: newer Gradle/Maven/Python variants, Elixir, and SBT are listed (plain text where dedicated pages do not exist yet). Formerly linked actions (dotNET, old Gradle JDK lines, Python 3.6–3.8, Scala) move into a new Deprecated GitHub Actions section.
Reviewed by Cursor Bugbot for commit 880b8da. Bugbot is set up for automated code reviews on this repo. Configure here.