-
Notifications
You must be signed in to change notification settings - Fork 4
feat(ci): added netlify toml to correctly build astro #176
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
Conversation
✅ Deploy Preview for developers-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
c48d166 to
e3cf308
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds Netlify configuration for preview deployments and comprehensive documentation about the dual deployment strategy (Netlify for previews, Google Cloud Storage for production). The changes ensure consistent builds using Bun across all deployment contexts and add helpful developer documentation.
- Adds
netlify.tomlwith build configuration and routing rules for Astro deployments - Updates dependency versions in
bun.lockto latest compatible releases - Adds detailed deployment documentation to README and creates GitHub Copilot instructions file
- Marks legacy deployment workflow as deprecated
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| netlify.toml | Configures Netlify builds with Bun and sets up client-side routing rewrites for the /developers path |
| bun.lock | Updates various Astro, Starlight, and tooling dependencies to newer versions |
| README.md | Adds comprehensive deployment documentation explaining Netlify preview vs GCS production deployments |
| .github/workflows/deploy.yml | Adds deprecation notice directing users to new workflow |
| .github/copilot-instructions.md | Creates new AI assistant instructions documenting project architecture, deployment, and common pitfalls |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
This pull request introduces comprehensive documentation and configuration updates to clarify and standardize deployment processes for the Interledger Developers Portal. The main focus is on improving developer onboarding, ensuring deployment consistency between preview and production environments, and deprecating outdated workflows. Below are the most important changes grouped by theme:
Documentation & Developer Guidance
.github/copilot-instructions.mdfile detailing project architecture, deployment procedures, configuration notes, common pitfalls, and development philosophy to help contributors and AI agents understand the project.README.mdto include clear explanations of both Netlify preview deployments and Google Cloud production deployments, as well as guidance on legacy workflow deprecation.Deployment Configuration
netlify.tomlconfiguration file that standardizes the build process using Bun, ensures the build output is nested under_netlify/builders/developers, and sets up redirect rules for proper client-side routing under the/developersbase path.Workflow Deprecation
.github/workflows/deploy.ymlas deprecated, directing contributors to use the new Google Cloud deployment workflow instead.