Skip to content

Conversation

@spastorelli
Copy link
Contributor

@spastorelli spastorelli commented Dec 4, 2025

This PR aims to add the GitHub issues integration.

Part https://linear.app/gitbook-x/issue/RND-8917/add-github-issues-integration

@changeset-bot
Copy link

changeset-bot bot commented Dec 4, 2025

⚠️ No Changeset found

Latest commit: ec335a6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@spastorelli spastorelli added the wip label Dec 4, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 4, 2025

Open in StackBlitz

bun add https://pkg.pr.new/GitbookIO/integrations/@gitbook/api@1079

commit: ec335a6

@spastorelli spastorelli force-pushed the steeve/github-issues-integration branch from 403348c to 5075da7 Compare December 4, 2025 18:18
@spastorelli spastorelli force-pushed the steeve/github-issues-integration branch from 5075da7 to 571bc06 Compare December 4, 2025 18:19
@spastorelli spastorelli removed the wip label Dec 5, 2025
@spastorelli spastorelli marked this pull request as ready for review December 5, 2025 22:38
Copy link
Member

@SamyPesse SamyPesse left a comment

Choose a reason for hiding this comment

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

Looks good

# GitHub
GITHUB_APP_INSTALL_URL: ${{ secrets.GITBOOK_GITHUB_APP_INSTALL_URL }}
GITHUB_APP_ID: ${{ secrets.GITBOOK_GITHUB_APP_ID }}
GITHUB_APP_NAME: ${{ secrets.GITHUB_APP_NAME }}
Copy link
Member

Choose a reason for hiding this comment

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

What is this?

Should it be a 1password entry now? we should avoid secrets

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's the name of the app that GitHub generates based on the title of the app that we provide. We need it to build the app installation URL (btw we use a similar approach in github-copilot integration). It changes based on the environment (e.g prod app != staging app != dev app), so we need to somehow pass it via the gitbook-manifest and be able to retrive it at runtime.

We don't have to store it in 1Password and hardcode the value in the manifest. But I don't know how to pass env variables per enviroment to integration other than passing the value as a secret.

Any suggestions?

@spastorelli spastorelli requested a review from SamyPesse December 9, 2025 09:24
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.

3 participants