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.

Sign up for GitHub

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

only checkout necessary directories #908

Merged
merged 25 commits into from
Nov 29, 2024
Merged

only checkout necessary directories #908

Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
5c1f944
only checkout necessary directories
robbymilo Nov 28, 2024
fb6adb2
trigger build
robbymilo Nov 28, 2024
d0d2016
ls source_dir
robbymilo Nov 28, 2024
6543565
trigger build
robbymilo Nov 28, 2024
57d7d9c
debug
robbymilo Nov 28, 2024
f19d87f
try sparse checkout
robbymilo Nov 28, 2024
5d15042
disable cone mode
robbymilo Nov 28, 2024
5b3fce5
try some bash
robbymilo Nov 28, 2024
ac0dcc6
remove quotes
robbymilo Nov 28, 2024
df7f6d7
add deploy-preview dir
robbymilo Nov 28, 2024
9360df9
typo
robbymilo Nov 28, 2024
43672c6
try exclusion
robbymilo Nov 28, 2024
6e4b770
more bash
robbymilo Nov 28, 2024
be3a556
add quotes
robbymilo Nov 28, 2024
212ba58
change quotes
robbymilo Nov 28, 2024
f495584
cleanup
robbymilo Nov 28, 2024
c40453d
try without trim
robbymilo Nov 28, 2024
fafdea9
revert trim removal
robbymilo Nov 28, 2024
2d3b6c9
remove trim
robbymilo Nov 28, 2024
13a93f7
hardcode docs dir
robbymilo Nov 28, 2024
de7c528
simplify
robbymilo Nov 29, 2024
964d9ff
fix dir
robbymilo Nov 29, 2024
839a4be
test
robbymilo Nov 29, 2024
0954478
test
robbymilo Nov 29, 2024
5db5612
revert content and ref changes
robbymilo Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy-pr-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:

jobs:
deploy-pr-preview:
uses: grafana/writers-toolkit/.github/workflows/deploy-preview.yml@main
uses: grafana/writers-toolkit/.github/workflows/deploy-preview.yml@robbymilo/deploy-preview
with:
sha: ${{ github.event.pull_request.head.sha }}
branch: ${{ github.head_ref }}
Expand Down
14 changes: 14 additions & 0 deletions .github/workflows/deploy-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great, that means I can get rid of trimming the source_directory.


# get the Dockerfile and nginx conf
- name: Sparse checkout
Expand All @@ -78,6 +81,17 @@ jobs:
sparse-checkout: |
deploy-preview

# 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: |
shopt -s extglob
rm -rf !(docs|deploy-preview-files|.git)
ls -al
ls -al ${{ inputs.source_directory }}

- name: Build website
if: github.event.action == 'opened' || github.event.action == 'synchronize'
shell: bash
Expand Down
1 change: 1 addition & 0 deletions docs/sources/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ If it's your first time using the guide, start with the [Get started](https://gr

Writers' Toolkit is open source and available at [`grafana/writers-toolkit`](https://github.com/grafana/writers-toolkit).
If you have questions, or feedback on how to improve this documentation, [open an issue](https://github.com/grafana/writers-toolkit/issues/new) and help make this an even better resource.
.