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

chore: migrate to reusable ref docs gh action #152

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: migrate to reusable ref docs gh action #152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ad477f
chore: migrate to reusable ref docs gh action
OmarAlJarrah Jan 12, 2025
61cd315
Merge branch 'main' into OmarAlJarrah/migrate-to-reusable-docs-deploy…
OmarAlJarrah Jan 13, 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
96 changes: 5 additions & 91 deletions .github/workflows/generate-reference-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,100 +2,14 @@ name: Deploy Reference Documentation

on:
workflow_dispatch:
inputs:
ref:
description: 'Choose the branch/tag/ref to deploy the reference documentation from'
required: true
default: 'main'
type: string
Comment on lines -5 to -10
Copy link
Member

Choose a reason for hiding this comment

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

Let's keep this option available.


permissions:
id-token: write

jobs:
deploy-reference-docs:
runs-on: ubuntu-latest

steps:
- name: Checkout "main" Branch
uses: actions/checkout@v4
with:
ref: ${{ inputs.ref }}

- name: Setup Java 21
uses: actions/setup-java@v4
with:
distribution: 'corretto'
java-version: '21'

- name: Configure Git
run: |
git config --global user.email "[email protected]"
git config --global user.name "eg-oss-ci"
git fetch --all

- name: Checkout "gh-pages" Branch
run: git checkout gh-pages

- name: Extract and Store Latest Live Docs Version Number
run: echo "LATEST_DOCS_VERSION=$(jq -r '.version' version.json)" >> $GITHUB_ENV

- name: Move Latest Docs to the "older" Directory (Archiving latest live release)
run: |
mkdir -p older/${{ env.LATEST_DOCS_VERSION }}
mv images -- '-lodging -connectivity -java -s-d-k' scripts styles index.html navigation.html not-found-version.html version.json older/${{ env.LATEST_DOCS_VERSION }}

- name: Move the "older" and "assets" Directories to a Temporary Workspace
run: mv older assets ${{ runner.temp }}

- name: Checkout ${{ inputs.ref }} Branch
run: git checkout ${{ inputs.ref }}

- name: Generate New Release Reference Docs
run: |
gradle -p code dokkaHtml -Pdokka-old-versions.location=${{ runner.temp }}/older -Pdokka-assets.location=${{ runner.temp }}/assets

- name: Extract and Store Newly Generated Docs Version Number
run: |
echo "NEW_DOCS_VERSION=$(jq -r '.version' code/build/dokka/html/version.json)" >> $GITHUB_ENV

- name: Check the New Release Version
run: |
for dir in ${{ runner.temp }}/older/*; do
if [ -d "$dir" ]; then
DIR_NAME=$(basename "$dir")
if [ "$DIR_Ngit remote get-url originAME" == "${{ env.NEW_DOCS_VERSION }}" ]; then
echo "Error: Reference Docs with version ${{env.NEW_DOCS_VERSION }} already exists."
echo "Hint: Make sure to update the project version in the pom.xml file"
exit 1
fi
fi
done

- name: Move the Newly Generated Docs to a Temporary Workspace
run: mv code/build/dokka/html ${{ runner.temp }}/${{ env.NEW_DOCS_VERSION }}

- name: Checkout "gh-pages" Branch
run: git checkout gh-pages

- name: Cleanup Old Docs from the Repository's Root
run: rm -rf code images older -- '-lodging -connectivity -java -s-d-k' scripts styles index.html navigation.html not-found-version.html version.json

- name: Move Newly Generated Docs to the Repository Root
run: |
rm -rf .gradle
mv ${{ runner.temp }}/${{ env.NEW_DOCS_VERSION }}/* .

- name: Commit the New Release
run: |
git add .
git commit -m "chore: publishing docs for version ${{ env.NEW_DOCS_VERSION }}"

- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
commit-message: "chore: publish docs for version ${{ env.NEW_DOCS_VERSION }}"
body: "This PR adds the reference documentation for version ${{ env.NEW_DOCS_VERSION }}."
title: "chore: publish docs for version ${{ env.NEW_DOCS_VERSION }}"
branch: "docs-update-${{ env.NEW_DOCS_VERSION }}"
uses: "ExpediaGroup/expediagroup-java-sdk/.github/workflows/generate-ref-docs.yaml@main"
with:
buildsystem: 'gradle'
secrets:
GITHUB_PAT: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
Loading