Seamless Neon GitHub App Connection: A Step-by-Step

Seamless Neon GitHub App Connection: A Step-by-Step Guide

Hey guys, let's dive into connecting your Neon project with GitHub using the official Neon GitHub App. We'll make sure your NEON project (repo: weathered-thunder-93205669) is all set up and ready to go.

Before We Start

Make sure you've prepared your repository for Neon. This guide assumes you've already set up the necessary files like .env.example, lib/db.ts, /api/health/db, migration SQL, and a GitHub Actions workflow that uses the DATABASE_URL secret.

Connecting Neon Console to GitHub

1. Open Your Project in Neon Console

Head over to your Neon Console and open your project NEON (repo ID: weathered-thunder-93205669).

2. Initiate GitHub / Integrations Settings

In your project dashboard, look for the GitHub / Integrations settings flow and open it.

3. Install or Authorize the Neon GitHub App

Now, it's time to connect your GitHub account with Neon. Install or authorize the Neon GitHub App for your NEON repository (mategzg/NEON).

Setting Up the Database Connection

4. Add the Repo Secret DATABASE_URL

In your GitHub repository settings, navigate to the Secrets section. Add a new repository secret named DATABASE_URL with the Neon pooled connection string.

Finalizing the Setup

5. Run the Neon check Workflow

To ensure everything is working as expected, manually trigger the Neon check workflow from your GitHub Actions tab.

Wrapping Up

That's it, folks! You've successfully connected your Neon project with GitHub using the Neon GitHub App. Remember, do not commit the real connection string to keep your data secure.

Happy coding, and until next time!