Skip to content

Conversation

@sgolebiewski-intel
Copy link
Contributor

📝 Description

Introduce per-repo docs build workflow. This allows greater control over the documentation build without needing to be tied to the orch-ci repo. NOTE: Some actions are still borrowed from orch-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:

  • 🐞 Bug fix – Non-breaking change which fixes an issue
  • 🚀 New feature – Non-breaking change which adds functionality
  • 🔨 Refactor – Non-breaking change which refactors the code base
  • 💥 Breaking change – Changes that break existing functionality
  • 📚 Documentation update
  • 🔒 Security update
  • 🧪 Tests
  • 🚂 CI

🧪 Testing Scenarios

Describe how the changes were tested and how reviewers can test them too:

  • ✅ Tested manually
  • 🤖 Ran automated end-to-end tests

✅ Checklist

Before submitting the PR, ensure the following:

  • 🔍 PR title is clear and descriptive
  • 📝 For internal contributors: If applicable, include the JIRA ticket number (e.g., ITEP-123456) in the PR title. Do not include full URLs
  • 💬 I have commented my code, especially in hard-to-understand areas
  • 📄 I have made corresponding changes to the documentation
  • ✅ I have added tests that prove my fix is effective or my feature works

@jouillet
Copy link
Contributor

@sgolebiewski-intel , can you make a modification to one of the documentation files to trigger the docs-build workflow? I don't have permissions to commit to this PR.

@sgolebiewski-intel sgolebiewski-intel force-pushed the introducing-per-repo-docs-build-workflow branch from 35dc0bf to 7cb2f90 Compare October 27, 2025 06:46
@jouillet
Copy link
Contributor

GitHub is complaining about secrets, which I find odd, since these are unchanged from before:
https://github.com/open-edge-platform/scenescape/actions/runs/18842139895

According to the GitHub documentation, this is valid syntax:
https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#example-of-onworkflow_callsecrets

I'm assuming the issue is actually the extraneous with:, and the secrets issue will disappear after the extraneous with: is removed.

@sgolebiewski-intel sgolebiewski-intel force-pushed the introducing-per-repo-docs-build-workflow branch from 3366225 to db922d6 Compare October 28, 2025 14:26
- 'controller/docs/**'
build_toplevel:
name: "Build Toplevel Documentation"
Copy link
Member

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"

Copy link
Contributor

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.

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.

5 participants