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

Replace individual inputs with JSON string array of inputs #1014

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
+324 −56
Open

Replace individual inputs with JSON string array of inputs #1014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
1efa0ba
Replace individual inputs with JSON string array of inputs
jdbaldry Jan 6, 2025
e90777a
drop! test
jdbaldry Jan 30, 2025
7c9dce8
fixup! Replace individual inputs with JSON string array of inputs
jdbaldry Jan 30, 2025
f239503
Fix concurrency
jdbaldry Jan 30, 2025
2431952
fixup! Replace individual inputs with JSON string array of inputs
jdbaldry Jan 30, 2025
afb61b0
fixup! Replace individual inputs with JSON string array of inputs
jdbaldry Jan 30, 2025
607a5c1
fixup! Replace individual inputs with JSON string array of inputs
jdbaldry Jan 30, 2025
13ce2c9
Fix sources JSON
jdbaldry Jan 30, 2025
8769352
fixup! test
jdbaldry Jan 30, 2025
8a6d7e0
Set token
jdbaldry Jan 30, 2025
ac021dd
Restore repo input
jdbaldry Jan 30, 2025
e4c334a
Try using first relative prefix
jdbaldry Jan 30, 2025
0e14952
Post all output URLs
jdbaldry Feb 4, 2025
0d853c4
Properly set multiline output
jdbaldry Feb 4, 2025
61d460f
fixup! Properly set multiline output
jdbaldry Feb 4, 2025
0b26909
fixup! Post all output URLs
jdbaldry Feb 4, 2025
8f6db67
fixup! Post all output URLs
jdbaldry Feb 4, 2025
b6f059d
Use existing branch input for checkout
jdbaldry Feb 5, 2025
f943851
fixup! Use existing branch input for checkout
jdbaldry Feb 5, 2025
e063423
Restore legacy behavior for migration
jdbaldry Feb 19, 2025
5912646
Remove requirement for legacy inputs
jdbaldry Feb 19, 2025
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
19 changes: 12 additions & 7 deletions .github/workflows/deploy-pr-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,19 @@ on:

jobs:
deploy-pr-preview:
uses: grafana/writers-toolkit/.github/workflows/deploy-preview.yml@main
if: ${{ ! github.event.pull_request.head.repo.fork }}
if: "!github.event.pull_request.head.repo.fork"
uses: grafana/writers-toolkit/.github/workflows/deploy-preview.yml@jdb/deploy-preview
with:
sha: ${{ github.event.pull_request.head.sha }}
branch: ${{ github.head_ref }}
event_number: ${{ github.event.number }}
title: ${{ github.event.pull_request.title }}
repo: writers-toolkit
website_directory: content/docs/writers-toolkit
relative_prefix: /docs/writers-toolkit/
index_file: false
sha: ${{ github.event.pull_request.head.sha }}
sources: |
[{
"index_file": null,
"relative_prefix": "/docs/writers-toolkit/",
"repo": "writers-toolkit",
"source_directory": "docs/sources",
"website_directory": "content/docs/writers-toolkit"
}]
title: ${{ github.event.pull_request.title }}
149 changes: 124 additions & 25 deletions .github/workflows/deploy-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,66 @@ name: deploy-preview
on:
workflow_call:
inputs:
# Legacy inputs
# Don't forget to make `sources` required when you remove these.
source_directory:
default: docs/sources
type: string
website_directory:
type: string
relative_prefix:
type: string
index_file: # creates the necessary project _index.md file for versioned repos
type: boolean
# End legacy inputs
sources:
description: |
sources is a JSON string describing multiple source mounts.

It replaces the individual inputs used in the previous version of this action.

The structure is an array of objects, each with the following keys:

index_file:
description: Path to index file used to redirect versioned projects. For example, "content/docs/mimir/_index.md".
required: true
type: string
relative_prefix:
description: The URL path prefix for the mount destination. For example, "/docs/mimir/latest/".
required: true
type: string
repo:
description: The Grafana repository name for the source files. For example, "mimir".
required: true
type: string
source_directory:
description: The path to the source files in the repository. For example, "docs/sources".
required: true
type: string
website_directory:
description: The path to mount the documentation in the website content structure. For example, "content/docs/mimir/latest".
required: true
type: string

The following example mounts both the Mimir documentation and the mimir-distributed Helm chart documentation:

[
{
"index_file": true,
"relative_prefix": "/docs/mimir/latest/",
"repo": "mimir",
"source_directory": "docs/sources/mimir",
"website_directory": "content/docs/mimir/latest"
},
{
"index_file": true,
"relative_prefix": "/docs/helm-charts/mimir-distributed/latest/",
"repo": "mimir",
"source_directory": "docs/sources/mimir-distributed",
"website_directory": "content/docs/helm-charts/mimir-distributed/latest"
}
]
type: string
sha:
required: true
type: string
Expand All @@ -12,24 +72,12 @@ on:
event_number:
required: true
type: string
title:
required: true
type: string
repo:
required: true
type: string
source_directory:
default: docs/sources
type: string
website_directory:
required: true
type: string
relative_prefix:
title:
required: true
type: string
index_file: # creates the necessary project _index.md file for versioned repos
required: true
type: boolean

env:
CLOUD_RUN_REGION: us-south1
Expand All @@ -41,7 +89,7 @@ concurrency:
jobs:
deploy-preview:
permissions:
contents: read
contents: read # Clone repositories.
id-token: write # Fetch Vault secrets.
pull-requests: write # Create or update PR comments.
statuses: write # Update GitHub status check with deploy preview link.
Expand All @@ -66,29 +114,27 @@ jobs:
body: |
:building_construction: Updating deploy preview...


- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
if: github.event.action == 'opened' || github.event.action == 'synchronize'
if: inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize')
with:
persist-credentials: false
sparse-checkout-cone-mode: false # exclude root files
sparse-checkout: docs

# get the Dockerfile and nginx conf
- name: Sparse checkout
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
if: github.event.action == 'opened' || github.event.action == 'synchronize'
with:
repository: "grafana/writers-toolkit"
ref: "main"
ref: jdb/deploy-preview
path: deploy-preview-files
persist-credentials: false
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'
if: inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize')
shell: bash
env:
SOURCE_DIRECTORY: ${{ inputs.source_directory }}
Expand All @@ -99,16 +145,31 @@ jobs:
ls -al "${SOURCE_DIRECTORY}"
ls -al deploy-preview-files

# 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: "!inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize')"
shell: bash
run: |
shopt -s extglob
rm -rf !(deploy-preview-files|.git)
ls -al .
ls -al deploy-preview-files

- name: Build website
if: github.event.action == 'opened' || github.event.action == 'synchronize'
shell: bash
env:
# Legacy input.
SOURCE_DIRECTORY: ${{ inputs.source_directory }}
WEBSITE_DIRECTORY: ${{ inputs.website_directory }}
INDEX_FILE: ${{ inputs.index_file }}
REPO: ${{ inputs.repo }}
run: |
./deploy-preview-files/deploy-preview/build.sh
# End legacy input.
GH_TOKEN: ${{ github.token }}
SOURCES: ${{ inputs.SOURCES }}
BRANCH: ${{ inputs.branch }}
run: ./deploy-preview-files/deploy-preview/build

- name: Print build header value
if: github.event.action == 'opened' || github.event.action == 'synchronize'
Expand Down Expand Up @@ -200,21 +261,47 @@ jobs:

- name: Send commit status
uses: ouzi-dev/commit-status-updater@26588d166ff273fc4c0664517359948f7cdc9bf1 # v2.0.2
if: github.event.action == 'opened' || github.event.action == 'synchronize'
if: inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize')
with:
name: deploy_preview
status: "${{ job.status }}"
url: "${{ steps.deploy.outputs.url }}${{ inputs.relative_prefix }}"

- name: Send commit status
uses: ouzi-dev/commit-status-updater@26588d166ff273fc4c0664517359948f7cdc9bf1 # v2.0.2
if: "!inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize')"
with:
name: deploy_preview
status: "${{ job.status }}"
url: "${{ steps.deploy.outputs.url }}${{ (fromJSON(inputs.sources))[0].relative_prefix }}"
Copy link
Contributor

Choose a reason for hiding this comment

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

I think only a single URL here is fine but it might cause some confusion.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah I meant to check if I can put multiple URLs into the status check but I don't think I can

description: "Public deploy preview"

- name: Get preview URLs
id: urls
if: "!inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize')"
shell: bash
env:
SOURCES: ${{ inputs.SOURCES }}
URL: ${{ steps.deploy.outputs.url }}
run: ./deploy-preview-files/deploy-preview/urls

- name: Create comment with available deploy preview
if: (github.event.action == 'opened' || github.event.action == 'synchronize') && steps.fc.outputs.comment-id == ''
if: inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize') && steps.fc.outputs.comment-id == ''
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
with:
issue-number: ${{ inputs.event_number }}
body: |
:computer: Deploy preview available: ${{ steps.deploy.outputs.url }}${{ inputs.relative_prefix }}

- name: Create comment with available deploy preview
if: "!inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize') && steps.fc.outputs.comment-id == ''"
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
with:
issue-number: ${{ inputs.event_number }}
body: |
:computer: Deploy preview available:
${{ steps.urls.outputs.urls }}

- name: Update comment with deleted deploy preview
if: github.event.action == 'closed'
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
Expand All @@ -225,12 +312,24 @@ jobs:
body: |
:computer: Deploy preview deleted.


- name: Update comment with available deploy preview
if: (github.event.action == 'opened' || github.event.action == 'synchronize') && steps.fc.outputs.comment-id != ''
if: inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize') && steps.fc.outputs.comment-id != ''
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
with:
comment-id: ${{ steps.fc.outputs.comment-id }}
issue-number: ${{ inputs.event_number }}
edit-mode: replace
body: |
:computer: Deploy preview available: ${{ steps.deploy.outputs.url }}${{ inputs.relative_prefix }}

- name: Update comment with available deploy preview
if: "!inputs.website_directory && (github.event.action == 'opened' || github.event.action == 'synchronize') && steps.fc.outputs.comment-id != ''"
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
with:
comment-id: ${{ steps.fc.outputs.comment-id }}
issue-number: ${{ inputs.event_number }}
edit-mode: replace
body: |
:computer: Deploy preview available:
${{ steps.urls.outputs.urls }}
Loading