fix: resolve markdownlint errors in docs and CONTRIBUTING #40
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
| # Project: hyperi-rustlib | |
| # File: .github/workflows/ci.yml | |
| # Purpose: Rust CI pipeline - Quality, Test | |
| # License: FSL-1.1-ALv2 | |
| # Copyright: (c) 2026 HYPERI PTY LIMITED | |
| # | |
| # Generated by: HyperI CI attach.sh (rust) | |
| # CI Repo: https://github.com/hyperi-io/ci | |
| # | |
| # IMPORTANT: Before triggering CI, always run a local build first: | |
| # cargo fmt --check && cargo clippy --all-features && cargo test --all-features | |
| name: CI | |
| on: | |
| push: | |
| branches: ["**"] | |
| paths-ignore: ['**.md', 'docs/**', 'LICENSE*', '.gitignore'] | |
| pull_request: | |
| paths-ignore: ['**.md', 'docs/**', 'LICENSE*', '.gitignore'] | |
| workflow_dispatch: | |
| jobs: | |
| detect: | |
| name: Detect Config | |
| runs-on: ${{ vars.GH_RUNNER_DEFAULT || 'ubuntu-latest' }} | |
| outputs: | |
| rust_features: ${{ steps.config.outputs.rust_features }} | |
| rust_test_tier: ${{ steps.config.outputs.rust_test_tier }} | |
| steps: | |
| - name: Generate token | |
| id: token | |
| uses: actions/create-github-app-token@v1 | |
| with: | |
| app-id: ${{ secrets.GH_APP_ID }} | |
| private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} | |
| owner: ${{ github.repository_owner }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| submodules: recursive | |
| token: ${{ steps.token.outputs.token }} | |
| - uses: ./ci/actions/setup/detect-build-config | |
| id: config | |
| with: | |
| scripts-path: ./ci/scripts | |
| quality: | |
| name: Quality | |
| needs: detect | |
| runs-on: ${{ vars.GH_RUNNER_DEFAULT || 'ubuntu-latest' }} | |
| steps: | |
| - name: Generate token | |
| id: token | |
| uses: actions/create-github-app-token@v1 | |
| with: | |
| app-id: ${{ secrets.GH_APP_ID }} | |
| private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} | |
| owner: ${{ github.repository_owner }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| submodules: recursive | |
| token: ${{ steps.token.outputs.token }} | |
| - uses: ./ci/actions/jobs/quality | |
| with: | |
| language: rust | |
| artifactory-url: ${{ vars.ARTIFACTORY_CARGO_URL }} | |
| artifactory-username: ${{ secrets.ARTIFACTORY_CI_USERNAME }} | |
| artifactory-password: ${{ secrets.ARTIFACTORY_CI_TOKEN }} | |
| rust-features: ${{ needs.detect.outputs.rust_features }} | |
| - name: Commit auto-fixes | |
| uses: stefanzweifel/git-auto-commit-action@v5 | |
| with: | |
| commit_message: 'docs: auto-fix markdown formatting [skip ci]' | |
| file_pattern: '**/*.md' | |
| test: | |
| name: Test | |
| needs: [detect, quality] | |
| runs-on: ${{ vars.GH_RUNNER_DEFAULT || 'ubuntu-latest' }} | |
| steps: | |
| - name: Generate token | |
| id: token | |
| uses: actions/create-github-app-token@v1 | |
| with: | |
| app-id: ${{ secrets.GH_APP_ID }} | |
| private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} | |
| owner: ${{ github.repository_owner }} | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| submodules: recursive | |
| token: ${{ steps.token.outputs.token }} | |
| - uses: ./ci/actions/jobs/test | |
| with: | |
| language: rust | |
| artifactory-url: ${{ vars.ARTIFACTORY_CARGO_URL }} | |
| artifactory-username: ${{ secrets.ARTIFACTORY_CI_USERNAME }} | |
| artifactory-password: ${{ secrets.ARTIFACTORY_CI_TOKEN }} | |
| rust-features: ${{ needs.detect.outputs.rust_features }} |