Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.2k
Convertdoc.yml workflow to be reusable#103914
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -28,7 +28,7 @@ permissions: | ||
| contents: read | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}-reusable | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This collides with the “parent” workflow if it's exactly the same, which is why it was required to introduce some difference. | ||
| cancel-in-progress: true | ||
| jobs: | ||
| @@ -37,6 +37,7 @@ jobs: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| outputs: | ||
| run-docs: ${{ steps.docs-changes.outputs.run-docs || false }} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. The part after | ||
| run_tests: ${{ steps.check.outputs.run_tests }} | ||
| run_hypothesis: ${{ steps.check.outputs.run_hypothesis }} | ||
| config_hash: ${{ steps.config_hash.outputs.hash }} | ||
| @@ -79,6 +80,28 @@ jobs: | ||
| id: config_hash | ||
| run: | | ||
| echo "hash=${{ hashFiles('configure', 'configure.ac', '.github/workflows/build.yml') }}" >> $GITHUB_OUTPUT | ||
| - name: Get a list of the changed documentation-related files | ||
| if: github.event_name == 'pull_request' | ||
| id: changed-docs-files | ||
| uses: Ana06/get-changed-files@v2.2.0 | ||
| with: | ||
| filter: | | ||
| Doc/** | ||
| Misc/** | ||
| .github/workflows/reusable-docs.yml | ||
Comment on lines +88 to +91 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This reimplements what was implemented through | ||
| - name: Check for docs changes | ||
| if: >- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. If this step is skipped, the job output above will fall back to | ||
| github.event_name == 'pull_request' | ||
| && steps.changed-docs-files.outputs.added_modified_renamed != '' | ||
| id: docs-changes | ||
| run: | | ||
| echo "run-docs=true" >> "${GITHUB_OUTPUT}" | ||
| check-docs: | ||
| name: Docs | ||
| needs: check_source | ||
| if: fromJSON(needs.check_source.outputs.run-docs) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. The job above sets either | ||
| uses: ./.github/workflows/reusable-docs.yml | ||
| check_generated_files: | ||
| name: 'Check if generated files are up to date' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I made the workflow file name prefixed with |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,8 @@ | ||
| name: Docs | ||
| on: | ||
| workflow_call: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This bit is what allows to “include” this workflow into another. | ||
| workflow_dispatch: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I kept this to make it possible to still trigger just this workflow separately, via a manual request. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. @hugovk this is the only bit I wasn't sure about — is it useful to keep this trigger at all. If not, deleting it could improve maintainability.. | ||
| permissions: | ||
| contents: read | ||