Skip to content

ci: Add PR previews with Netlify #53

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

Merged
merged 2 commits into from
Apr 30, 2025
Merged

Conversation

MoritzWeber0
Copy link
Member

@MoritzWeber0 MoritzWeber0 commented Apr 29, 2025

Description

This PR adds the foundation for PR previews using Netlify. Netlify is a cloud computing company that offers fast & easy deployment of pages. The free plan is sufficient and no credit card is required.

Using the provided configuration, a preview is built for each opened PR automatically.
An example can be seen here, where I tested the functionality: MoritzWeber0#1 (comment)
This avoids cases like "It works on my machine" and also makes reviews easier. You don't to set up the local environment every time for small changes, instead you can just check the result.

The only disadvantage is that someone with permissions in this repository has to create a Netlify account and link it to the GitHub repository.

It's not required to configure anything else than a page name, the whole configuration is part of the small file netlify.toml.

It's just an idea to improve the workflow for non-tech people since they can see the result without setting up the development environment. But I can also understand if you don't want to implement it.

A similar behavior is also possible with an implementation in GitHub Pages, I can have a look at it if wanted. Something like: https://github.com/marketplace/actions/deploy-pr-preview

@MoritzWeber0 MoritzWeber0 marked this pull request as draft April 30, 2025 07:13
@lenderom lenderom marked this pull request as ready for review April 30, 2025 21:56
@lenderom lenderom merged commit 87bd02d into fipguide:main Apr 30, 2025
1 check passed
@MoritzWeber0 MoritzWeber0 added the technical Technical issues, e.g. related to Hugo, HTML, CSS, deployment, etc. label Jun 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical Technical issues, e.g. related to Hugo, HTML, CSS, deployment, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants