only checkout necessary directories #908
Conversation
|
💻 Deploy preview available: https://deploy-preview-writers-toolkit-908-zb444pucvq-vp.a.run.app/docs/writers-toolkit/ |
| @@ -66,6 +66,9 @@ jobs: | |||
|
|
|||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |||
| if: github.event.action == 'opened' || github.event.action == 'synchronize' | |||
| with: | |||
| sparse-checkout-cone-mode: false # exclude root files | |||
| sparse-checkout: docs | |||
There was a problem hiding this comment.
We can make this configurable in the future if we like but every standard project and every one that I can think of (ignoring plugins) uses this structure.
There was a problem hiding this comment.
Great, that means I can get rid of trimming the source_directory.
.github/workflows/deploy-preview.yml
Outdated
| # sparse checkout with cone mode disabled includes root files, even when using exclusions | ||
| # see https://github.com/actions/checkout/issues/1430#issuecomment-1756326892 | ||
| - name: Keep only necessary files | ||
| if: github.event.action == 'opened' || github.event.action == 'synchronize' | ||
| shell: bash | ||
| run: | | ||
| find . -mindepth 1 -not \( -path "./${{ inputs.source_directory }}" -o -path "./${{ inputs.source_directory }}/*" -o -path "./deploy-preview-files" -o -path "./deploy-preview-files/*" \) -exec rm -rf {} + | ||
| ls -al | ||
| ls -al $trimmed_value | ||
|
|
There was a problem hiding this comment.
Can we also just consider trashing all files that aren't our docs directory?
Or perhaps another way is to do all the checking out into the default workspace but then copying what we want into a new subdirectory.
The workspace tree may then look like:
.
├── build
│ ├── deploy-preview-files
│ ├── dist
│ └── docs
│ └── sources
├── deploy-preview-files
└── grafana
There was a problem hiding this comment.
In that previous comment, the grafana directory contains the grafana/grafana repo checkout (sparse or otherwise). The build directory is where we copy the deploy-preview-files; from the grafana/writers-toolkit checkout and docs/sources/ from the grafana/grafana checkout.
We then switch to that build directory before running all the rest of the action
There was a problem hiding this comment.
Yep, that is what I'm trying with the find command. There is probably a cleaner way.
There was a problem hiding this comment.
Oh right yeah, the find finds all files that aren't in our preferred list and removes them. That may be easiest actually because I recall that performing multiple steps in a subdirectory of an action is really verbose.
I think the find command along with maybe capturing the "to keep" directories in a Bash array for readability would be a good way to go.
I'm happy to pick this up tomorrow if you like. I came across this PR because I was hoping to give you a contribution for your review tomorrow but wanted to make sure that I wasn't stepping on your toes haha.
There was a problem hiding this comment.
Take a look at 0954478 and its run in the grafana repo: https://github.com/grafana/grafana/actions/runs/12081483043/job/33690724463
robbymilo
requested review from
chri2547,
clayton-cornell,
knylander-grafana and
a team
as code owners
robbymilo
removed request for
chri2547,
knylander-grafana and
clayton-cornell
robbymilo
force-pushed
the
robbymilo/deploy-preview
branch
from
6e1e5bb to
de7c528
Compare
for https://github.com/grafana/website/issues/10101
Looks as though https://github.com/grafana/grafana/blob/main/.dockerignore#L8 is making the deploy preview at grafana/grafana#97140 fail due to ignoring the
distdir.As @jdbaldry suggested, we should only clone the necessary source dir. We could do this with sparse checkout, however root files are still included as the checkout step does not support the exclusions (see the comment). Instead we have a lovely find command that deletes anything expect the specified files.
Todo: