Skip to content
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

Build the docs on PRs #128

Merged
merged 3 commits into from Mar 18, 2024
Merged

Build the docs on PRs #128

merged 3 commits into from Mar 18, 2024

Conversation

ThorstenHans
Copy link
Contributor

With this PR, the Deploy to GitHub Pages action is also executed within PRs targeting main.

Publishing preview builds on GitHub pages from PRs is not officially supported. However, this would - at least - act as a build verification.

With this commit CI will run also on PRs targeting main. Artifact publishing and deployment is disabled using an if condition

Signed-off-by: Thorsten Hans <thorsten.hans@fermyon.com>
Copy link
Contributor

@vdice vdice left a comment

Choose a reason for hiding this comment

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

I might prefer we create a separate workflow for PRs for a few reasons:

  1. This workflow currently uses a concurrency config to prevent simultaneous deploys... as configured, this would mean PR runs could/would queue
  2. There are some token permissions that we wouldn't necessarily want PRs to inherit (admittedly, a fix for this is to move those under the deploy job which would be gated on pushes to main)
  3. If/when we do find a PR preview strategy, I imagine it would make sense for that to be used in a separate PR workflow as well.

WDYT?

I'd also be fine with something like this in the near-term if some of the 'blockers' from above (1 and 2) can be addressed.

.github/workflows/deploy.yaml Outdated Show resolved Hide resolved
@ThorstenHans
Copy link
Contributor Author

I'm also happy with a dedicated workflow. Will go ahead and split it, which will automatically resolve the other finding

Signed-off-by: Thorsten Hans <thorsten.hans@fermyon.com>
Copy link
Contributor

@vdice vdice left a comment

Choose a reason for hiding this comment

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

Nothing blocking; LGTM!

.github/workflows/pr.yaml Outdated Show resolved Hide resolved
.github/workflows/pr.yaml Outdated Show resolved Hide resolved
Signed-off-by: Thorsten Hans <thorsten.hans@fermyon.com>
@ThorstenHans ThorstenHans merged commit 88f045e into main Mar 18, 2024
1 check passed
@ThorstenHans ThorstenHans deleted the feature/pr-builds branch March 18, 2024 21:01
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.

None yet

2 participants