Skip to content

cicd: Add docs build parameters #23

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

Merged
AlexanderLanin merged 1 commit into from
Jun 4, 2025
Merged

cicd: Add docs build parameters #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/actions/deploy-versioned-pages/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,5 +149,5 @@ runs:
with:
issue-number: ${{github.event.pull_request.number}}
body: |
The created documentation from the pull request is available at: [docu-html](https://eclipse-score.github.io/${{ github.event.repository.name }}/${{ steps.calc.outputs.target_folder }})
The created documentation from the pull request is available at: [docu-html](https://${{ github.event.repository.owner.login }}.github.io/${{ github.event.repository.name }}/${{ steps.calc.outputs.target_folder }})
reactions: rocket
15 changes: 5 additions & 10 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,8 @@ jobs:

- name: Build documentation
run: |
bazel build ${{ inputs.bazel-target }}

# Strip // and use path form to find the tarball
TARGET="${{ inputs.bazel-target }}"
TARGET_PATH="${TARGET#//}" # remove leading //
TARGET_PATH="${TARGET_PATH/:/\/}" # replace : with /
cp bazel-bin/$TARGET_PATH.tar github-pages.tar

bazel run ${{ inputs.bazel-target }}
tar -cf github-pages.tar _build
Copy link
Copy Markdown
Member

@AlexanderLanin AlexanderLanin Jun 4, 2025

Choose a reason for hiding this comment

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

Did you try this? Don't we need to add e.g. /html?

Copy link
Copy Markdown
Member Author

@nicu1989 nicu1989 Jun 4, 2025

Choose a reason for hiding this comment

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

yes, tested in forked repo, see here: eclipse-score/docs-as-code#70 (comment)


- name: Upload documentation artifact
uses: actions/upload-artifact@v4.4.0
Expand Down Expand Up @@ -117,12 +111,13 @@ jobs:
git checkout --orphan gh-pages
git rm -rf . || true
REPO_NAME=$(basename "${REPO}")
OWNER_NAME="${REPO%%/*}"

touch versions.json
echo "[" > versions.json
echo " {" >> versions.json
echo " \"version\": \"main\"," >> versions.json
echo " \"url\": \"https://eclipse-score.github.io/${REPO_NAME}/main/\"" >> versions.json
echo " \"url\": \"https://${OWNER_NAME}.github.io/${REPO_NAME}/main/\"" >> versions.json
echo " }" >> versions.json
echo "]" >> versions.json

Expand Down Expand Up @@ -163,5 +158,5 @@ jobs:
id: pages-deployment
uses: eclipse-score/cicd-workflows/.github/actions/deploy-versioned-pages@main
with:
source_folder: extracted_docs/html
source_folder: extracted_docs/_build
deployment_type: ${{ inputs.deployment_type }}