diff --git a/packages/github/_dev/build/docs/README.md b/packages/github/_dev/build/docs/README.md index a7202bbf7c8..ff3afe95b89 100644 --- a/packages/github/_dev/build/docs/README.md +++ b/packages/github/_dev/build/docs/README.md @@ -92,6 +92,11 @@ To use this integration, users must use GitHub Apps or Personal Access Token wit **Note**: The Issues API can fetch a maximum of 30,000 issues when querying at the organization level. No limitation exists when querying for the repository level. +**Note**: Ensure the GitHub Personal Access Token includes following fine-grained permission for the repository: +- At least `Read-only` permission on Issues +- At least `Read-only` permission on Metadata +If misconfigured, the integration could run successfully without any data being processed. Alternatively, you might encounter an error like `⁠GET: server returned a 404 (Not Found)`. + {{fields "issues"}} {{event "issues"}} diff --git a/packages/github/changelog.yml b/packages/github/changelog.yml index a6dedaf7bcc..a394385671e 100644 --- a/packages/github/changelog.yml +++ b/packages/github/changelog.yml @@ -1,4 +1,9 @@ # newer versions go on top +- version: "2.21.0" + changes: + - description: Clarify GitHub PAT permissions required for Issues data stream. + type: enhancement + link: https://github.com/elastic/integrations/pull/16758 - version: "2.20.0" changes: - description: Update `event.kind` to "alert" for `code_scanning.alert_created` and `secret_scanning_alert.create` actions. diff --git a/packages/github/docs/README.md b/packages/github/docs/README.md index 15405fba3b2..214b395afeb 100644 --- a/packages/github/docs/README.md +++ b/packages/github/docs/README.md @@ -780,6 +780,11 @@ To use this integration, users must use GitHub Apps or Personal Access Token wit **Note**: The Issues API can fetch a maximum of 30,000 issues when querying at the organization level. No limitation exists when querying for the repository level. +**Note**: Ensure the GitHub Personal Access Token includes following fine-grained permission for the repository: +- At least `Read-only` permission on Issues +- At least `Read-only` permission on Metadata +If misconfigured, the integration could run successfully without any data being processed. Alternatively, you might encounter an error like `⁠GET: server returned a 404 (Not Found)`. + **Exported fields** | Field | Description | Type | Unit | Metric Type | diff --git a/packages/github/manifest.yml b/packages/github/manifest.yml index e26cc9e98b9..3450afa693f 100644 --- a/packages/github/manifest.yml +++ b/packages/github/manifest.yml @@ -1,6 +1,6 @@ name: github title: GitHub -version: "2.20.0" +version: "2.21.0" description: Collect logs from GitHub with Elastic Agent. type: integration format_version: "3.4.0"