updates the abstracts for each of the HowTo guides, and renames the topic heading from 'HOWTOS' to 'Guides' #261
Workflow file for this run
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
| name: Pull Request | |
| on: | |
| pull_request: | |
| types: [opened, reopened, synchronize] | |
| push: | |
| branches: [main] | |
| env: | |
| SWIFTLY_BOOTSTRAP_VERSION: 0.4.0-dev | |
| jobs: | |
| soundness: | |
| name: Soundness | |
| uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main | |
| with: | |
| license_header_check_enabled: false | |
| license_header_check_project_name: "Swift.org" | |
| api_breakage_check_enabled: false | |
| docs_check_enabled: false | |
| format_check_enabled: false | |
| shell_check_enabled: false | |
| unacceptable_language_check_enabled: true | |
| tests-selfhosted: | |
| name: Test (Self Hosted) / ${{ matrix.container }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| container: ["ubuntu:20.04", "ubuntu:22.04", "ubuntu:24.04", "redhat/ubi9", "debian:12", "fedora:39"] | |
| container: | |
| image: ${{ matrix.container }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Prepare the action | |
| run: ./scripts/prep-gh-action.sh --install-swiftly | |
| - name: Build and Test | |
| run: swift test | |
| releasebuildcheck: | |
| name: Release Build Check | |
| runs-on: ubuntu-latest | |
| container: | |
| image: "redhat/ubi9" | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Prepare the action | |
| run: ./scripts/prep-gh-action.sh --install-swiftly | |
| - name: Build Artifact | |
| run: swift run build-swiftly-release --use-rhel-ubi9 --skip "999.0.0" | |
| - name: Upload Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: swiftly-release-x86_64 | |
| path: .build/release/swiftly-*.tar.gz | |
| if-no-files-found: error | |
| retention-days: 1 | |
| formatcheck: | |
| name: Format Check | |
| runs-on: ubuntu-latest | |
| container: | |
| image: ubuntu:22.04 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Prepare the action | |
| run: ./scripts/prep-gh-action.sh --install-swiftly | |
| - name: Check format | |
| run: swift run swiftformat --lint --dryrun . || (echo "Please run 'swift run swiftformat .' to format the source code."; exit 1) | |
| docscheck: | |
| name: Documentation Check | |
| runs-on: ubuntu-latest | |
| container: | |
| image: ubuntu:24.04 | |
| steps: | |
| - name: Install git | |
| run: apt-get update && apt-get -y install git | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Prepare the action | |
| run: ./scripts/prep-gh-action.sh --install-swiftly | |
| - name: Generate Swiftly CLI Reference and Check for Differences | |
| run: swift package plugin --allow-writing-to-package-directory generate-docs-reference && bash -c 'git config --global --add safe.directory $(pwd)' && git diff --exit-code Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md || (echo "The documentation hasn't been updated with the latest swiftly command-line reference. Please run `swift package plugin generate-docs-reference` and commit/push the changes."; exit 1) | |
| - name: Generate Documentation Set | |
| run: swift package --allow-writing-to-directory .build/docs generate-documentation --target SwiftlyDocs --output-path .build/docs | |
| - name: Upload Documentation Artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: swiftly-docs | |
| path: .build/docs/** | |
| if-no-files-found: error | |
| retention-days: 1 |