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

Publish GitHub pages with explicit GitHub Action Steps #2461

Merged
merged 4 commits into from
Mar 6, 2024

Conversation

vorburger
Copy link
Member

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

Related to #2232

Description

This PR contains x3 Commits. You may want to review and merge #2459 and then #2460 separately, first? Or all together here - your call.

I'm intentionally raising small changes; this alone doesn't "do" all that much, yet; my plan is to gradually build upon this.

This step should, if it works, make the exact same website content that we currently have up on https://google.github.io/android-fhir/ re-appear.

What changes is that instead of GitHub "implicitly" building it for us, via its https://github.com/google/android-fhir/actions/workflows/pages/, we "control" it - which allows us hook our own documentation build steps into it.

All the magic GitHub Workflow Action YAML gobbledygook introduced here is inspired by https://github.com/enola-dev/enola/blob/ed2b1755b9dbf1a0668c86f80048d8bded94de4a/.github/workflows/ci.yaml#L131, where I learnt how to do this to create https://docs.enola.dev.

Type
Choose one: Builds

Checklist

  • I have read and acknowledged the Code of conduct.
  • I have read the Contributing page.
  • I have signed the Google Individual CLA, or I am covered by my company's Corporate CLA.
  • I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
  • I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the style guide of this project.
  • I have run ./gradlew check and ./gradlew connectedCheck to test my changes locally.
  • I have built and run the demo app(s) to verify my change fixes the issue and/or does not break the demo app(s).

This should, if it works, make the exact same website content that we currently have up on https://google.github.io/android-fhir/ appear.

What changes is that instead of GitHub "implicitly" building it for us, via its https://github.com/google/android-fhir/actions/workflows/pages/, we "control" it - which allows us hook our own documentation build steps into it.

All the magic GitHub Workflow Action YAML gobbledygook introduced here is inspired by https://github.com/enola-dev/enola/blob/ed2b1755b9dbf1a0668c86f80048d8bded94de4a/.github/workflows/ci.yaml#L131, where I learnt how to do this to create https://docs.enola.dev.
@vorburger vorburger requested review from santosh-pingle and a team as code owners March 3, 2024 16:39
@vorburger
Copy link
Member Author

@jingtang10 ping on reviewing and if OK perhaps merging this one? (And also what do you want to do about this one?)

@vorburger
Copy link
Member Author

@jingtang10 Thank You for approval. I've now merged this with master, and resolved a related merge conflict.

I'll "self-merge" this, based on your approval, once the Kokoro build passed.

@vorburger vorburger merged commit ac5fd62 into master Mar 6, 2024
4 checks passed
@vorburger vorburger deleted the github-pages-explicit-deploy3 branch March 6, 2024 16:27
@vorburger
Copy link
Member Author

I've "verified" and found that this worked! See this run and note this (visually) still looks as before! Nice hit on 1st try... 🥇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

2 participants