-
Notifications
You must be signed in to change notification settings - Fork 34
[DOCS] Introduce per-repo docs build workflow #505
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
base: main
Are you sure you want to change the base?
[DOCS] Introduce per-repo docs build workflow #505
Conversation
|
@sgolebiewski-intel , can you make a modification to one of the documentation files to trigger the |
511cc29 to
35dc0bf
Compare
35dc0bf to
7cb2f90
Compare
|
GitHub is complaining about According to the GitHub documentation, this is valid syntax: I'm assuming the issue is actually the extraneous |
Co-authored-by: Jeremy Ouillette <[email protected]>
3366225 to
db922d6
Compare
| - 'controller/docs/**' | ||
| build_toplevel: | ||
| name: "Build Toplevel Documentation" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please take a look on actionlint results and make required changes - Link
My suggestion is to specify runner and steps for each job to be able to reuse GHA action defined in actions/docs-build.
Here example how it should looks like:
build_toplevel:
name: "Build Toplevel Documentation"
runs-on: ubuntu-latest
needs: filter
if: ${{ needs.filter.outputs.toplevel_changed == 'true' }}
steps:
- uses: ./.github/actions/docs-build
with:
SYS_ORCH_GITHUB: ${{ secrets.SYS_ORCH_GITHUB }}
DOC_AWS_ACCESS_KEY_ID: ${{ secrets.DOC_AWS_ACCESS_KEY_ID }}
DOC_AWS_SECRET_ACCESS_KEY: ${{ secrets.DOC_AWS_SECRET_ACCESS_KEY }}
exclude_patterns: "README.md, adr, design, development"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is that not what we already have?
I think the problem is that the secrets syntax ${{ secrets.DOC_AWS_ACCESS_KEY_ID }} is somehow not allowed when calling GitHub Actions (not to be confused with GitHub Workflows).
I'm thinking we should use environment variables via env: to import the secrets. I'll propose some changes in a bit.
📝 Description
Introduce per-repo docs build workflow. This allows greater control over the documentation build without needing to be tied to the
orch-cirepo. NOTE: Some actions are still borrowed fromorch-ci, such as configuring AWS credentials, but the documentation specific actions are now local.Recreating Jeremy Ouillette's #503
✨ Type of Change
Select the type of change your PR introduces:
🧪 Testing Scenarios
Describe how the changes were tested and how reviewers can test them too:
✅ Checklist
Before submitting the PR, ensure the following: