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

Replace individual inputs with JSON string array of inputs #1014

Merged
merged 22 commits into from
Feb 24, 2025

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Jan 30, 2025

This lets us build multiples sources in a single deploy preview as demonstrated in grafana/mimir#10580.

I also think it allows us to mount source projects into Grafana Cloud documentation directly instead of a publishing directory although it doesn't use Hugo mounts for that.

Let me know if you'd like me to test anything specifically out for you so you can be confident in the changes.

This can be rolled out safely as tested in:

Signed-off-by: Jack Baldry jack.baldry@grafana.com

  • I've used a relevant pull request (PR) title.
  • I've added a link to any relevant issues in the PR description.
  • I've checked my changes on the deploy preview and they look good.
  • I've added an entry to the What's new page (only required for notable changes).

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Copy link
Contributor

github-actions bot commented Jan 30, 2025

💻 Deploy preview deleted.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry marked this pull request as ready for review February 4, 2025 17:40
This requires the same branch name for builds across multiple repositories but that's not too painful and isn't yet a planned use case.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Copy link
Contributor

@robbymilo robbymilo left a comment

Choose a reason for hiding this comment

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

Looks good, just a question on updating each repo's workflow file.

@@ -204,16 +227,26 @@ jobs:
with:
name: deploy_preview
status: "${{ job.status }}"
url: "${{ steps.deploy.outputs.url }}${{ inputs.relative_prefix }}"
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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry requested a review from robbymilo February 19, 2025 09:29
Copy link
Contributor

@robbymilo robbymilo left a comment

Choose a reason for hiding this comment

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

Looks good, great improvement!

Copy link
Contributor

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/_index.md $${8.80\space\color{green}(Δ-0.61)}$$ $${11.04\space\color{green}(Δ-0.08)}$$ $${8.31\space\color{green}(Δ-0.51)}$$ $${60.62\space\color{green}(Δ+1.19)}$$ $${10.05\space\color{green}(Δ-0.67)}$$ $${41.67\space\color{green}(Δ-1.25)}$$ $${10.25\space\color{green}(Δ-0.44)}$$
docs/sources/contribute/_index.md $${7.64\space\color{black}(Δ+0.00)}$$ $${10.28\space\color{black}(Δ+0.00)}$$ $${8.44\space\color{black}(Δ+0.00)}$$ $${56.93\space\color{black}(Δ+0.00)}$$ $${9.76\space\color{black}(Δ+0.00)}$$ $${38.69\space\color{black}(Δ+0.00)}$$ $${10.55\space\color{black}(Δ+0.00)}$$
docs/sources/contribute/release-notes/index.md $${8.33\space\color{black}(Δ+0.00)}$$ $${9.65\space\color{black}(Δ+0.00)}$$ $${8.75\space\color{black}(Δ+0.00)}$$ $${60.32\space\color{black}(Δ+0.00)}$$ $${10.47\space\color{black}(Δ+0.00)}$$ $${38.15\space\color{black}(Δ+0.00)}$$ $${11.32\space\color{black}(Δ+0.00)}$$
docs/sources/review/lint-prose/rules.md $${4.27\space\color{black}(Δ+0.00)}$$ $${3.93\space\color{black}(Δ+0.00)}$$ $${5.94\space\color{black}(Δ+0.00)}$$ $${57.45\space\color{black}(Δ+0.00)}$$ $${8.02\space\color{black}(Δ+0.00)}$$ $${36.97\space\color{black}(Δ+0.00)}$$ $${7.44\space\color{black}(Δ+0.00)}$$
docs/sources/structure/topic-types/_index.md $${8.34\space\color{black}(Δ+0.00)}$$ $${11.41\space\color{black}(Δ+0.00)}$$ $${8.12\space\color{black}(Δ+0.00)}$$ $${58.19\space\color{black}(Δ+0.00)}$$ $${9.32\space\color{black}(Δ+0.00)}$$ $${41.76\space\color{black}(Δ+0.00)}$$ $${10.29\space\color{black}(Δ+0.00)}$$
docs/sources/structure/topic-types/section/index.md $${6.62\space\color{black}(Δ+0.00)}$$ $${9.63\space\color{black}(Δ+0.00)}$$ $${7.11\space\color{black}(Δ+0.00)}$$ $${63.82\space\color{black}(Δ+0.00)}$$ $${7.06\space\color{black}(Δ+0.00)}$$ $${38.14\space\color{black}(Δ+0.00)}$$ $${8.84\space\color{black}(Δ+0.00)}$$
docs/sources/whats-new.md $${9.69\space\color{black}(Δ+0.00)}$$ $${13.09\space\color{black}(Δ+0.00)}$$ $${9.74\space\color{black}(Δ+0.00)}$$ $${46.61\space\color{black}(Δ+0.00)}$$ $${11.47\space\color{black}(Δ+0.00)}$$ $${70.33\space\color{black}(Δ+0.00)}$$ $${11.21\space\color{black}(Δ+0.00)}$$
docs/sources/write/front-matter/index.md $${6.66\space\color{black}(Δ+0.00)}$$ $${9.17\space\color{black}(Δ+0.00)}$$ $${7.82\space\color{black}(Δ+0.00)}$$ $${61.01\space\color{black}(Δ+0.00)}$$ $${9.77\space\color{black}(Δ+0.00)}$$ $${35.82\space\color{black}(Δ+0.00)}$$ $${10.82\space\color{black}(Δ+0.00)}$$
docs/sources/write/image-guidelines/index.md $${7.26\space\color{black}(Δ+0.00)}$$ $${10.76\space\color{black}(Δ+0.00)}$$ $${8.41\space\color{black}(Δ+0.00)}$$ $${52.87\space\color{black}(Δ+0.00)}$$ $${10.53\space\color{black}(Δ+0.00)}$$ $${37.58\space\color{black}(Δ+0.00)}$$ $${11.05\space\color{black}(Δ+0.00)}$$
docs/sources/write/shortcodes/index.md $${7.11\space\color{black}(Δ+0.00)}$$ $${10.44\space\color{black}(Δ+0.00)}$$ $${8.02\space\color{black}(Δ+0.00)}$$ $${56.35\space\color{black}(Δ+0.00)}$$ $${9.34\space\color{black}(Δ+0.00)}$$ $${39.08\space\color{black}(Δ+0.00)}$$ $${10.63\space\color{black}(Δ+0.00)}$$
View metric targets
Metric Range Ideal score
AutomatedReadability 6 (very easy read) to 14 (extremely difficult read) 8 or less
ColemanLiau 6 (very easy read) to 17 (extremely difficult read) 9 or less
FleschKincaid 6 (very easy read) to 17 (extremely difficult read) 8 or less
FleschReadingEase 100 (very easy read) to 0 (extremely difficult read) 70 or more
GunningFog 6 (very easy read) to 17 (extremely difficult read) 10 or less
LIX 20 (very easy read) to 60+ (extremely difficult read) 35 or less
SMOG 6 (very easy read) to 17 (extremely difficult read) 10 or less

@jdbaldry jdbaldry merged commit aec9ddc into main Feb 24, 2025
11 checks passed
@jdbaldry jdbaldry deleted the jdb/deploy-preview branch February 24, 2025 13:32
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.

2 participants