Repository navigation
docs: reconcile FireCraft status, execution docs, and wiki sources #123
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
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 |
|---|---|---|
| @@ -1,133 +1,168 @@ | ||
| # GitHub Actions backup CI. GitForge is primary; this is the fallback. | ||
| # Docs-only changes get a fast whitespace/conflict-marker check and do not | ||
| # install Rust/Aegis/coverage tooling or run the full xtask gate. The workflow | ||
| # remains active for every PR/push so required checks are not path-filtered | ||
| # into a permanently pending state. | ||
| name: CI (backup) | ||
| on: | ||
| push: | ||
| branches: ["**"] | ||
| tags: ["v*"] | ||
| pull_request: | ||
| branches: [main] | ||
| permissions: | ||
| contents: read | ||
| env: | ||
| CARGO_TERM_COLOR: always | ||
| jobs: | ||
| changes: | ||
| name: classify-change | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| docs_only: ${{ steps.classify.outputs.docs_only }} | ||
| code_changed: ${{ steps.classify.outputs.code_changed }} | ||
| steps: | ||
| - name: Checkout full history | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Classify changed paths (fail closed on unknown/empty diff) | ||
| id: classify | ||
| shell: bash | ||
| env: | ||
| EVENT_NAME: ${{ github.event_name }} | ||
| REF: ${{ github.ref }} | ||
| BEFORE_SHA: ${{ github.event.before }} | ||
| PR_BASE_SHA: ${{ github.event.pull_request.base.sha }} | ||
| run: | | ||
| set -euo pipefail | ||
| if [[ "$EVENT_NAME" == "workflow_dispatch" || "$REF" == refs/tags/* ]]; then | ||
| echo "docs_only=false" >> "$GITHUB_OUTPUT" | ||
| echo "code_changed=true" >> "$GITHUB_OUTPUT" | ||
| exit 0 | ||
| fi | ||
| base="$BEFORE_SHA" | ||
| if [[ "$EVENT_NAME" == "pull_request" ]]; then base="$PR_BASE_SHA"; fi | ||
| if [[ -z "$base" || "$base" =~ ^0+$ ]] || ! git cat-file -e "$base^{commit}" 2>/dev/null; then | ||
| echo "docs_only=false" >> "$GITHUB_OUTPUT" | ||
| echo "code_changed=true" >> "$GITHUB_OUTPUT" | ||
| exit 0 | ||
| fi | ||
| if [[ "$EVENT_NAME" == "pull_request" ]]; then | ||
| files=$(git diff --name-only "$base...$GITHUB_SHA") | ||
| else | ||
| files=$(git diff --name-only "$base" "$GITHUB_SHA") | ||
| fi | ||
| if [[ -z "$files" ]]; then | ||
| echo "docs_only=false" >> "$GITHUB_OUTPUT" | ||
| echo "code_changed=true" >> "$GITHUB_OUTPUT" | ||
| exit 0 | ||
| fi | ||
| docs_only=true | ||
| while IFS= read -r file; do | ||
| [[ -z "$file" ]] && continue | ||
| case "$file" in | ||
| docs/*|README.md|CHANGELOG.md|CONTRIBUTING.md|LICENSE|CODE_OF_CONDUCT.md) ;; | ||
| *) docs_only=false; break ;; | ||
| esac | ||
| done <<< "$files" | ||
| echo "docs_only=$docs_only" >> "$GITHUB_OUTPUT" | ||
| if [[ "$docs_only" == "true" ]]; then | ||
| echo "code_changed=false" >> "$GITHUB_OUTPUT" | ||
| else | ||
| echo "code_changed=true" >> "$GITHUB_OUTPUT" | ||
| fi | ||
| printf 'Changed files:\n%s\n' "$files" | ||
| docs: | ||
| name: docs-only-check | ||
| runs-on: ubuntu-latest | ||
| needs: [changes] | ||
| if: needs.changes.outputs.docs_only == 'true' | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Validate whitespace and merge markers | ||
| run: | | ||
| set -euo pipefail | ||
| if grep -RInE '^(<<<<<<<|=======|>>>>>>>)' docs README.md CONTRIBUTING.md 2>/dev/null; then | ||
|
Comment on lines
+84
to
+87
Contributor
There was a problem hiding this comment.
 |
||
| echo "Unresolved merge-conflict marker found in documentation." | ||
| exit 1 | ||
| fi | ||
| fmt: | ||
| name: fmt | ||
| runs-on: ubuntu-latest | ||
| needs: [changes] | ||
| if: needs.changes.outputs.code_changed == 'true' | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Install Rust | ||
| uses: dtolnay/rust-toolchain@stable | ||
| with: | ||
| components: rustfmt | ||
| - name: Check formatting | ||
| run: cargo fmt --all -- --check | ||
| - name: Check web formatting | ||
| run: cargo fmt --manifest-path web/Cargo.toml -- --check | ||
| gate: | ||
| name: gate | ||
| runs-on: ubuntu-latest | ||
| needs: [changes, fmt] | ||
| if: needs.changes.outputs.code_changed == 'true' | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Install Rust | ||
| uses: dtolnay/rust-toolchain@stable | ||
| with: | ||
| components: clippy, rustfmt | ||
| - name: Install Aegis | ||
| run: | | ||
| set -euo pipefail | ||
| url=https://github.com/aliasfoxkde/aegis/releases/download/v0.6.3/aegis-linux-x86_64.tar.gz | ||
| curl -sSL -o aegis.tar.gz "$url" | ||
| echo "835fad56172f8977a91424a580d0a3ec0c5b59fea99f4c2eb4c0a88fce30ff9e aegis.tar.gz" | sha256sum -c - | ||
| tar xzf aegis.tar.gz aegis | ||
| sudo mv aegis /usr/local/bin/aegis | ||
| aegis --version | ||
| - name: Install wasm32 target | ||
| run: rustup target add wasm32-unknown-unknown | ||
| - name: Cache cargo registry | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.cargo/registry | ||
| key: cargo-registry-${{ hashFiles('**/Cargo.lock') }} | ||
| - name: Cache cargo index | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.cargo/git | ||
| key: cargo-index-${{ hashFiles('**/Cargo.lock') }} | ||
| - name: Cache build artifacts | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: target | ||
| key: cargo-build-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }} | ||
| restore-keys: cargo-build-${{ runner.os }}- | ||
| - name: Cache cargo-llvm-cov | ||
| id: cache-llvc | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.cargo/bin/cargo-llvm-cov | ||
| key: cargo-llvm-cov-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }} | ||
| - name: Install cargo-llvm-cov (if uncached) | ||
| if: steps.cache-llvc.outputs.cache-hit != 'true' | ||
| run: cargo install cargo-llvm-cov --locked | ||
| - name: Cache trunk | ||
| id: cache-trunk | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.cargo/bin/trunk | ||
| key: trunk-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }} | ||
| - name: Install trunk (if uncached) | ||
| if: steps.cache-trunk.outputs.cache-hit != 'true' | ||
| run: cargo install trunk --locked | ||
| - name: Full gate (xtask ci-no-fmt) | ||
| run: cargo run --package xtask -- ci-no-fmt | ||
| - name: Web bundle smoke | ||
| if: startsWith(github.ref, 'refs/tags/v') | ||
| run: cargo run --package xtask -- dist --web | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
Include rename source paths in change classification.
If a commit moves
Cargo.tomltodocs/archived-Cargo.toml, Git can report only the destination through--name-only. The classifier then accepts the change as documentation-only, although the workspace manifest was removed. Bothfmtandgateare skipped. Git enables rename detection by default and documents--name-onlyas reporting post-image paths. (git-scm.com)Add
--no-renamesto both diff commands. This makes the source deletion participate in classification.Proposed fix
Also applies to: 54-54