CI: Speed up jobs and abtract documentation building #14985
+209
−61
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # SPDX-FileCopyrightText: 2021 The Elixir Team | ||
|
|
||
| name: Build Elixir Documentation | ||
| description: Builds ExDoc and generates Elixir documentation | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| inputs: | ||
| otp_version: | ||
| description: The exact OTP version (major.minor[.patch]) | ||
| required: true | ||
|
|
||
| ex_doc_version: | ||
| description: ExDoc version (main or latest_stable) | ||
| required: true | ||
|
|
||
| warnings_as_errors: | ||
| description: Fails if ExDoc generates warnings | ||
| default: "false" | ||
|
|
||
| zip: | ||
| description: Whether to zip the docs | ||
| default: "false" | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - uses: erlef/setup-beam@e6d7c94229049569db56a7ad5a540c051a010af9 # v1.20.4 | ||
| with: | ||
| otp-version: ${{ inputs.otp_version }} | ||
| version-type: strict | ||
|
|
||
| - name: Compile Elixir | ||
| shell: bash | ||
| run: | | ||
| make compile | ||
| echo "$PWD/bin" >> $GITHUB_PATH | ||
|
|
||
| - name: Build info | ||
| shell: bash | ||
| run: bin/elixir --version | ||
|
|
||
| - name: Get ExDoc reference | ||
| shell: bash | ||
| run: | | ||
| if [ "${{ inputs.ex_doc_version }}" = "main" ]; then | ||
| ref=main | ||
| else | ||
| ref=v$(curl -s https://hex.pm/api/packages/ex_doc | jq --raw-output '.latest_stable_version') | ||
| fi | ||
|
|
||
| echo "EX_DOC_REF=$ref" >> $GITHUB_ENV | ||
|
|
||
| - name: Checkout ExDoc | ||
| uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 | ||
| with: | ||
| repository: elixir-lang/ex_doc | ||
| ref: ${{ env.EX_DOC_REF }} | ||
| path: ex_doc | ||
|
|
||
| - name: Compile ExDoc | ||
| shell: bash | ||
| env: | ||
| LANG: C.UTF-8 | ||
| run: | | ||
| mv ex_doc ../ex_doc | ||
| cd ../ex_doc | ||
| ../elixir/bin/mix do local.rebar --force + local.hex --force + deps.get + compile && \ | ||
| echo "ExDoc successfully built." | ||
|
|
||
| - name: Set DOCS_OPTIONS | ||
| shell: bash | ||
| run: | | ||
| if [[ "${{ inputs.warnings_as_errors }}" == "true" ]]; then | ||
| echo "DOCS_OPTIONS=--warnings-as-errors" >> $GITHUB_ENV | ||
| else | ||
| echo "DOCS_OPTIONS=" >> $GITHUB_ENV | ||
| fi | ||
|
|
||
| - name: Build docs | ||
| shell: bash | ||
| env: | ||
| LANG: C.UTF-8 | ||
| run: | | ||
| cd ../elixir | ||
| git fetch --tags | ||
| make ${{ inputs.zip == 'true' && 'Docs.zip' || 'docs' }} && \ | ||
| if [[ "${{ inputs.warnings_as_errors }}" == "true" ]]; then | ||
| echo "Docs successfully generated without warnings." | ||
| else | ||
| echo "Docs successfully generated." | ||
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # SPDX-FileCopyrightText: 2021 The Elixir Team | ||
|
|
||
| name: Elixir Documentation | ||
|
|
||
| on: | ||
| push: | ||
| paths: &paths-filter | ||
| - .github/workflows/documentation.yml | ||
| - .github/workflows/build_docs/**/* | ||
| - CHANGELOG.md | ||
| - Makefile | ||
| - VERSION | ||
| - lib/**/* | ||
|
|
||
| # Ignore | ||
| - "!lib/*/test/**/*" | ||
|
|
||
| pull_request: | ||
| paths: *paths-filter | ||
|
|
||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build_docs: | ||
| name: Build docs | ||
| runs-on: ubuntu-24.04 | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 | ||
|
|
||
| - name: Build docs | ||
| uses: ./.github/workflows/build_docs | ||
| with: | ||
| otp_version: "28.1" | ||
| ex_doc_version: "main" | ||
| warnings_as_errors: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Can you please revert the precise "paths"? Those other files change rarely and one day we may add a markdown fixture that actually changes the test, and we will spend a long time without noticing it. Unless the files are common and change frequently and they do non't need to run (the case for
lib/*/pages/**/*.md, we shouldn't worry about excluding them).