Skip to content

Conversation

@clement-fouque
Copy link
Contributor

@clement-fouque clement-fouque commented Jan 5, 2026

Proposed commit message

This pull request updates the GitHub integration documentation and metadata to clarify the required permissions for GitHub Personal Access Tokens (PATs). It also bumps the integration version to 2.21.0 and adds a changelog entry for this enhancement.

Documentation improvements:

  • Updated both packages/github/docs/README.md and packages/github/_dev/build/docs/README.md to specify that the GitHub PAT must have at least "Read-only" permissions on Issues and Metadata, and warns that missing permissions may cause the integration to start without ingesting data. [1] [2]

Versioning and changelog:

  • Bumped the integration version to 2.21.0 in packages/github/manifest.yml.
  • Added a changelog entry describing the new documentation about GitHub PAT permissions in packages/github/changelog.yml.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

@clement-fouque clement-fouque added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:github GitHub Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] labels Jan 5, 2026
@elastic-vault-github-plugin-prod

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@clement-fouque clement-fouque marked this pull request as ready for review January 5, 2026 13:01
@clement-fouque clement-fouque requested a review from a team as a code owner January 5, 2026 13:01
@elasticmachine
Copy link

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@kcreddy kcreddy self-requested a review January 6, 2026 09:10
Copy link
Contributor

@kcreddy kcreddy left a comment

Choose a reason for hiding this comment

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

@clement-fouque, can you also update your PR commit message accordingly after the latest commit?

@elasticmachine
Copy link

💚 Build Succeeded

History

Copy link
Contributor

@kcreddy kcreddy left a comment

Choose a reason for hiding this comment

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

Thanks!

@clement-fouque clement-fouque merged commit 44e7abe into main Jan 6, 2026
9 checks passed
@clement-fouque clement-fouque deleted the update-github-documentation branch January 6, 2026 14:23
@elastic-vault-github-plugin-prod

Package github - 2.21.0 containing this change is available at https://epr.elastic.co/package/github/2.21.0/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:github GitHub Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[github]: failed to execute template labels in Issues datastream

5 participants