22
33<p align =" center " >
44 <picture >
5- <source media="(prefers-color-scheme: dark)" srcset="./docs/neon-logo-dark-color .svg">
6- <img alt="Neon logo" src="./docs/neon-logo-light-color .svg">
5+ <source media="(prefers-color-scheme: dark)" srcset="./docs/logos/ neon-logo-dark.svg">
6+ <img alt="Neon logo" src="./docs/logos/ neon-logo-light.svg">
77 </picture >
88</p >
99
@@ -20,28 +20,24 @@ pull requests are created for review before merging the changes back into the
2020main branch. By including schema changes as a comment in the pull request,
2121reviewers can easily assess the differences directly within the pull request.
2222
23- <p align =" center " >
24- <picture >
25- <source media="(prefers-color-scheme: dark)" srcset="./docs/comment-dark-mode.png">
26- <img alt="Neon logo" src="./docs/comment-light-mode.png" style="max-width: 1500px;">
27- </picture >
28- </p >
23+ You can take a look at the [ example PR comment] ( docs/pr_comment.md ) to see what
24+ the output looks like.
2925
3026## Contributing
3127
3228If you would like to contribute to the development of this GitHub Action, see
33- [ Neon Schema Diff Action Development ] ( docs/development.md )
29+ [ docs/development.md ] ( docs/development.md ) .
3430
3531## How to set up the NEON_API_KEY
3632
3733Using the action requires adding a Neon API key to your GitHub Secrets. There
3834are two ways you can perform this setup:
3935
40- - ** Using the Neon GitHub Integration** (recommended) — this integration
36+ - ** Using the Neon GitHub Integration** (recommended 👍 ) — this integration
4137 connects your Neon project to your GitHub repository, creates an API key, and
4238 sets the API key in your GitHub repository for you. See
43- [ Neon GitHub Integration] ( / docs/guides/neon-github-integration) for
44- instructions.
39+ [ Neon GitHub Integration] ( https://neon.tech/ docs/guides/neon-github-integration)
40+ for instructions.
4541- ** Manual setup** — this method requires obtaining a Neon API key and
4642 configuring it manually in your GitHub repository.
4743
7167
7268Alternatively, you can use ` ${{ vars.NEON_PROJECT_ID }}` to get your
7369` project_id` . If you have set up the
74- [Neon GitHub Integration](/ docs/guides/neon-github-integration), the
75- ` NEON_PROJECT_ID` variable will be defined as a variable in your GitHub
70+ [Neon GitHub Integration](https://neon.tech/ docs/guides/neon-github-integration),
71+ the `NEON_PROJECT_ID` variable will be defined as a variable in your GitHub
7672repository.
7773
7874By default, the schema diff is calculated between the `compare_branch` and its
9187 your_job:
9288 permisions:
9389 pull-request: write
90+ contents: write
9491 ...other permissions needed for the rest of the job
9592 steps:
9693 - uses: neondatabase/schema-diff-action@v1
0 commit comments