Skip to content

GitHub Actions: add regional API endpoint docs and sync supported/deprecated actions list - #1699

Merged
mihaisau-snyk merged 7 commits into
mainfrom
doct-2329-github-actions-regional-endpoints
Sep 2, 2026
Merged

GitHub Actions: add regional API endpoint docs and sync supported/deprecated actions list#1699
mihaisau-snyk merged 7 commits into
mainfrom
doct-2329-github-actions-regional-endpoints

Conversation

@mihaisau-snyk

@mihaisau-snyk mihaisau-snyk commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Summary

Closes out the GitHub Actions docs work tracked under epic DOCT-2329.

Three changes to the GitHub Actions integration docs:

  1. New pageregional-api-endpoints.md, documenting how to set the SNYK_API environment 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)
  2. Link addition in the main GitHub Actions README pointing to the new page, in the same style as the existing Setup Action callout. (DOCT-2330)
  3. Supported/deprecated actions list sync — the GitHub Actions README listed actions that are now deprecated in 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 the snyk/actions repo README. (DOCT-2333)

Notes for reviewers

  • The newly added action names (Elixir-1.18, and the new Gradle/Maven/Python/SBT variants) don't have dedicated action pages yet — only the generic per-language pages exist. Left as plain text rather than linking to pages that don't exist.

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_API in 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 to SUMMARY.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.

@snyk-io

snyk-io Bot commented Aug 31, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@mihaisau-snyk mihaisau-snyk left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Annotated each edit with a short summary and the relevant Jira ticket for reviewers.

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses Regional API endpoints both as page title and link label. Using Custom API endpoints here 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 errors is an outlier across the corpus (zero occurrences). The established house pattern is ## Troubleshooting, with 14 occurrences corpus-wide. Standardizing to ## Troubleshooting matches 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 page regional-api-endpoints.md will need an entry added to developer-tools/SUMMARY.md under GitHub actions for Snyk setup and checking for vulnerabilities so that GitBook publishes it in the navigation tree.

Open in Web View Automation 

Sent by Cursor Automation: PR review for User Docs

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

The current head commit e40288e is reviewed.

Open in Web View Automation 

Sent by Cursor Automation: PR review for User Docs

@mihaisau-snyk
mihaisau-snyk marked this pull request as ready for review September 1, 2026 10:09
@mihaisau-snyk
mihaisau-snyk requested a review from a team as a code owner September 1, 2026 10:09

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Open in Web View Automation 

Sent by Cursor Automation: PR review for User Docs

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current head commit 1711568 is reviewed.

Open in Web View Automation 

Sent by Cursor Automation: PR review for User Docs

mihaisau-snyk and others added 7 commits September 2, 2026 15:29
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.
@mihaisau-snyk
mihaisau-snyk force-pushed the doct-2329-github-actions-regional-endpoints branch from 2b09b49 to 880b8da Compare September 2, 2026 12:35
@mihaisau-snyk
mihaisau-snyk merged commit 24791ef into main Sep 2, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants