Add PR preview pruning and retention management by Yashisinghal285 · Pull Request #378 · layer5io/getnighthawk

Yashisinghal285 · 2026-06-16T19:54:09Z

Description

This PR adds preview pruning and retention management for PR preview deployments.

What changed

Adds PREVIEW_RETENTION_LIMIT = 6
Implements pruning of old pr-preview/pr-* directories
Uses sparse checkout for efficient gh-pages maintenance
Ensures only 6 most recent previews are kept
Adds notifications when previews are pruned
Preserves cleanup-on-close behavior

Issue

Fixes #377

Notes for Reviewers

Workflow runs after PR preview deployment
Only gh-pages pr-preview directory is modified
Safe for concurrent PR workflows

Checklist

I tested the workflow locally / validated syntax
I understand this modifies GitHub Actions behavior

Signed commits

Yes, I signed my commits

github-actions · 2026-06-16T19:55:48Z

🚀 Preview deployment: https://layer5io.github.io/getnighthawk/pr-preview/pr-378/

Note: Preview may take a moment (GitHub Pages deployment in progress). Please wait and refresh. Track deployment here

Yashisinghal285 · 2026-06-16T19:58:59Z

Hi maintainers 👋
This PR implements preview pruning and retention management as per #377.
Ready for review when convenient.

Yashisinghal285 · 2026-06-21T07:45:01Z

Hi maintainers 👋

I noticed the failing lint check appears to be timing out during package loading (context deadline exceeded).

This PR only modifies build-and-preview-site.yml and docs/_data/discuss/nighthawk.json, and does not modify .github/workflows/ci.yml, which runs the lint job.

Please let me know if you'd like any changes from my side or if there is anything else I can help investigate.

Thanks! 🙌

Bhumikagarggg · 2026-06-27T19:00:39Z

-<center><h1>301 Moved Permanently</h1></center>
-<hr><center>cloudflare</center>
-</body>
-</html>


What is use of changing this file.

@Yashisinghal285 ??

@Bhumikagarggg Thanks for pointing this out. This file wasn't intentionally modified as part of the preview pruning feature. It changed while I updated my branch and resolved the merge conflict with the latest master. The functional changes for this PR are only in build-and-preview-site.yml.

Bhumikagarggg · 2026-06-27T19:01:18Z

I approved this PR by mistake.

Bhumikagarggg · 2026-06-27T19:02:49Z


 jobs:
  build-and-deploy-preview:
+    outputs:


Please move output section after runs-on

@Bhumikagarggg Done, thank you for the suggestion. I've moved the outputs section below runs-on as requested. Could you please take another look when you have a chance?

Sbragul26 · 2026-06-28T03:01:14Z

+
+          git add pr-preview
+          git commit -m "Prune old PR previews" || true
+          git push || true


Replace git push || true with git push instead of ignoring push failures.

Yashisinghal285 · 2026-06-28T03:19:50Z

@Sbragul26 Thanks for the review! I've updated the workflow by replacing git push || true with git push as suggested. Please take another look when you have a chance.

Sbragul26 · 2026-06-28T03:51:00Z

+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          git add pr-preview
+          git commit -m "Prune old PR previews" || true


For this too replace git commit -m "Prune old PR previews" with this.

Thanks for the review! I've removed || true from the git commit command since the workflow already checks for staged changes before attempting the commit.

Sbragul26 · 2026-07-02T11:45:07Z

+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          git add pr-preview


Could we remove this? git add pr-preview was already called above (line 123).

Signed-off-by: l5io <ci@layer5.io> Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Signed-off-by: l5io <ci@layer5.io> Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Bhumikagarggg · 2026-07-02T22:48:14Z

I tested this PR, and it looks good to me. You can see the test PRs here: https://github.com/Bhumikagarggg/getnighthawk/pulls

However, I think we should remove the paths filter. In the future, if someone opens a PR with an empty or minimal change, the build-preview workflow may not run, which could cause preview pruning to miss that PR.

if a user pushes an empty commit (or a commit that doesn't modify any of the monitored paths) to re-trigger the preview after pruning, the build-preview workflow won't run.

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Yashisinghal285 · 2026-07-09T16:02:19Z

Hi @Sbragul26, @Bhumikagarggg,

Just following up on this PR. I've addressed all the requested review comments, and the PR now has no merge conflicts and an approval. The remaining failing lint check appears to be unrelated to the changes in this PR.

Could you please let me know if anything else is required from my side? If everything looks good, I'd really appreciate it if this PR could be merged when you have time. Thank you!

Yashisinghal285 · 2026-07-16T12:11:33Z

Hi @Sbragul26, @Bhumikagarggg, @banana-three-join, @hortison 👋

Just a friendly follow-up on this PR. I've addressed all the requested review comments, the PR has an approval, and there are no merge conflicts. The remaining lint check appears to be unrelated to the changes in this PR.

If everything looks good, I'd really appreciate it if you could take a final look and merge it when you have time. Please let me know if there's anything else you'd like me to update.

Thank you!

Yashisinghal285 force-pushed the issue-377-preview-pruning branch from 831bd43 to 2732b56 Compare June 19, 2026 19:05

Bhumikagarggg approved these changes Jun 27, 2026

View reviewed changes

Bhumikagarggg suggested changes Jun 27, 2026

View reviewed changes

Sbragul26 suggested changes Jun 28, 2026

View reviewed changes

Yashisinghal285 requested review from Bhumikagarggg and Sbragul26 July 2, 2026 10:35

Yashisinghal285 force-pushed the issue-377-preview-pruning branch from fabd3f8 to db614c0 Compare July 2, 2026 10:59

Sbragul26 suggested changes Jul 2, 2026

View reviewed changes

leecalcote and others added 7 commits July 2, 2026 17:27

Updated nighthawk.json with new discussion posts

cc3041d

Signed-off-by: l5io <ci@layer5.io> Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Add PR preview pruning and retention management

dba598a

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Updated nighthawk.json with new discussion posts

9dc737d

Signed-off-by: l5io <ci@layer5.io> Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Move outputs below runs-on

d5fe425

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Do not ignore git push failures

4986f4e

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Do not ignore git commit failures

830779f

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Remove duplicate git add

43e2601

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Yashisinghal285 force-pushed the issue-377-preview-pruning branch from cc111e9 to 43e2601 Compare July 2, 2026 11:58

Merge branch 'master' into issue-377-preview-pruning

5da580b

Yashisinghal285 requested a review from Sbragul26 July 2, 2026 13:20

ritzorama approved these changes Jul 2, 2026

View reviewed changes

Bhumikagarggg suggested changes Jul 2, 2026

View reviewed changes

Remove paths filter from preview workflow

d0c1754

Signed-off-by: Yashi Singhal285 <yashi.singhal410@gmail.com>

Yashisinghal285 force-pushed the issue-377-preview-pruning branch from 5b5597a to d0c1754 Compare July 2, 2026 23:08

Bhumikagarggg approved these changes Jul 2, 2026

View reviewed changes

Bhumikagarggg requested review from banana-three-join and hortison July 11, 2026 11:09

Uh oh!

Conversation

Yashisinghal285 commented Jun 16, 2026

Description

What changed

Issue

Notes for Reviewers

Checklist

Signed commits

Uh oh!

github-actions Bot commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Yashisinghal285 commented Jun 16, 2026

Uh oh!

Yashisinghal285 commented Jun 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bhumikagarggg commented Jun 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Yashisinghal285 commented Jun 28, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Yashisinghal285 commented Jul 9, 2026

Uh oh!

Yashisinghal285 commented Jul 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

github-actions Bot commented Jun 16, 2026 •

edited

Loading