Skip to content

docs(CONTRIBUTING.md): update steps for adding a new extension #1691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

qiaofenlin
Copy link

@qiaofenlin qiaofenlin commented Jul 4, 2025

Fix broken Dockerfile link in CONTRIBUTING.md

Description:
I noticed that the Dockerfile link in the CONTRIBUTING.md file was broken (404). I have attempted to fix this issue in this pull request.

Reason for Major Changes:
While fixing the link, I found that there are multiple versions of Dockerfiles in the current project. Therefore, I updated the documentation to reflect this and to help contributors add extensions to the appropriate Dockerfile(s).

Screenshots:
image

Notes:
If there are any problems with my changes, please feel free to point them out.
Or, feel free to make further modifications based on this PR. Thank you!

@qiaofenlin qiaofenlin requested review from a team as code owners July 4, 2025 07:28
Copy link
Collaborator

@samrose samrose left a comment

Choose a reason for hiding this comment

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

@qiaofenlin thanks for your great contribution! I left a few notes on on the PR. The contributing is very out of date. Definitely the change you submitted about supporting multiple Dockerfiles is good and accurate. The rest is superceded by Supabase use of Nix. I think we'll include your contribution on the Dockerfile variations, but we need to also update the rest on how to contribute extensions.

@qiaofenlin
Copy link
Author

@samrose Thank you for your review and suggestions!

I have updated the documentation according to your feedback and addressed the issues you pointed out.
If there’s anything else that needs adjustment, please let me know. Thanks again for your help!

Copy link
Collaborator

@samrose samrose left a comment

Choose a reason for hiding this comment

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

We should also remove all these lines since we don't do any of this in Dockerfiles any more

Here's a minimal example:

ARG pg_graphql_release=1.1.0

####################
# 19-pg_graphql.yml
####################
FROM base as pg_graphql
# Download package archive
ARG pg_graphql_release
ADD "https://github.com/supabase/pg_graphql/releases/download/v${pg_graphql_release}/pg_graphql-v${pg_graphql_release}-pg${postgresql_major}-${TARGETARCH}-linux-gnu.deb" \
    /tmp/pg_graphql.deb

####################
# Collect extension packages
####################
FROM scratch as extensions
COPY --from=pg_graphql /tmp/*.deb /tmp/

Using this process maximises the effectiveness of Docker layer caching, which significantly speeds up our CI builds.

@samrose
Copy link
Collaborator

samrose commented Jul 9, 2025

If you remove those lines, I'll approve and we'll expand on it from there, as there is more to know, but I don't expect anyone outside of Supabse to yet know all of the other contributing info based on recent changes.

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.

2 participants