Skip to content

Commit b436b87

Browse files
authored
impr: add new icon (#9)
1 parent 676e54d commit b436b87

12 files changed

Lines changed: 95 additions & 18 deletions

File tree

.github/workflows/linter.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
uses: super-linter/super-linter/slim@v7
4242
env:
4343
DEFAULT_BRANCH: main
44-
FILTER_REGEX_EXCLUDE: dist/**/*
44+
FILTER_REGEX_EXCLUDE: dist/**/*|pr_comment.md
4545
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4646
VALIDATE_ALL_CODEBASE: true
4747
VALIDATE_JAVASCRIPT_STANDARD: false

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
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
2020
main branch. By including schema changes as a comment in the pull request,
2121
reviewers 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

3228
If 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

3733
Using the action requires adding a Neon API key to your GitHub Secrets. There
3834
are 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

@@ -71,8 +67,8 @@ steps:
7167
7268
Alternatively, 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
7672
repository.
7773

7874
By default, the schema diff is calculated between the `compare_branch` and its
@@ -91,6 +87,7 @@ jobs:
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

dist/index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/comment-dark-mode.png

-342 KB
Binary file not shown.

docs/comment-light-mode.png

-344 KB
Binary file not shown.

docs/logos/logo-dark.svg

Lines changed: 16 additions & 0 deletions
Loading

docs/logos/logo-light.svg

Lines changed: 16 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)