Skip to content

Commit

Permalink
Call check-external-types, deny, and docs workflows from tidy
Browse files Browse the repository at this point in the history
  • Loading branch information
@taiki-e
taiki-e committed Jan 12, 2025
1 parent 821f53d commit 5630c3f
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 72 deletions.
12 changes: 0 additions & 12 deletions .github/workflows/check-external-types.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,12 @@ jobs:
timeout-minutes: 60
steps:
- uses: taiki-e/checkout-action@v1
- id: pre
run: |
IFS=$'\n\t'
trap -- 's=$?; printf >&2 "%s\n" "${0##*/}:${LINENO}: \`${BASH_COMMAND}\` exit with ${s}"; exit ${s}' ERR
metadata=$(cargo metadata --format-version=1 --no-deps)
# Publishing is unrestricted if null, and forbidden if an empty array.
if [[ -n "$(jq -c '. as $metadata | .workspace_members[] as $id | $metadata.packages[] | select(.id == $id and .publish != [] and .targets[].kind[] == "lib")' <<<"${metadata}")" ]]; then
printf 'has-lib=true\n' >>"${GITHUB_OUTPUT}"
fi
- uses: taiki-e/github-actions/install-rust@main
with:
toolchain: ${{ inputs.rust }}
if: steps.pre.outputs.has-lib == 'true'
- uses: taiki-e/cache-cargo-install-action@v2
with:
tool: cargo-check-external-types@0.1.13
if: steps.pre.outputs.has-lib == 'true'
# Refs:
# - https://github.com/rust-lang/docs.rs/blob/HEAD/crates/metadata/lib.rs
# - https://github.com/rust-lang/docs.rs/blob/HEAD/src/docbuilder/rustwide_builder.rs
Expand Down Expand Up @@ -153,4 +142,3 @@ jobs:
)
fi
done
if: steps.pre.outputs.has-lib == 'true'
183 changes: 123 additions & 60 deletions .github/workflows/tidy.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,37 @@ on:
required: false
type: string
default: nightly
target:
clippy:
required: false
type: boolean
default: true
clippy-target:
required: false
type: string
args:
clippy-args:
required: false
type: string
clippy:
check-external-types:
required: false
type: boolean
default: true
fuzzy_provenance_casts:
deny:
required: false
type: boolean
default: true
unqualified_local_imports:
deny-args:
required: false
type: string
docs:
required: false
type: boolean
default: true
docs-target:
required: false
type: string
docs-args:
required: false
type: string

env:
CARGO_INCREMENTAL: 0
Expand All @@ -51,7 +64,31 @@ defaults:
shell: bash --noprofile --norc -CeEuo pipefail {0}

jobs:
prepare:
runs-on: ubuntu-latest
timeout-minutes: 60
steps:
- uses: taiki-e/checkout-action@v1
- id: parse
run: |
if [[ -n "$(git ls-files '*.rs')" ]]; then
printf 'rust=true\n' >>"${GITHUB_OUTPUT}"
metadata=$(cargo metadata --format-version=1 --no-deps)
# Publishing is unrestricted if null, and forbidden if an empty array.
if [[ -n "$(jq -c '. as $metadata | .workspace_members[] as $id | $metadata.packages[] | select(.id == $id and .publish != [])' <<<"${metadata}")" ]]; then
printf 'rust-pub=true\n' >>"${GITHUB_OUTPUT}"
if [[ -n "$(jq -c '. as $metadata | .workspace_members[] as $id | $metadata.packages[] | select(.id == $id and .publish != [] and .targets[].kind[] == "lib")' <<<"${metadata}")" ]]; then
printf 'rust-pub-lib=true\n' >>"${GITHUB_OUTPUT}"
fi
fi
fi
outputs:
rust: ${{ steps.parse.outputs.rust }}
rust-pub: ${{ steps.parse.outputs.rust-pub }}
rust-pub-lib: ${{ steps.parse.outputs.rust-pub-lib }}

tidy:
needs: prepare
runs-on: ubuntu-latest
timeout-minutes: 60
permissions:
Expand All @@ -60,22 +97,57 @@ jobs:
repository-projects: read # for gh pr edit --add-assignee
steps:
- uses: taiki-e/checkout-action@v1
- id: pre
run: |
if [[ -n "$(git ls-files '*.rs')" ]]; then
printf 'rust=true\n' >>"${GITHUB_OUTPUT}"
fi
- uses: taiki-e/github-actions/install-rust@main
with:
toolchain: ${{ inputs.rust }}
component: rustfmt
if: steps.pre.outputs.rust == 'true'
if: needs.prepare.outputs.rust == 'true'
- uses: taiki-e/install-action@shellcheck
- uses: taiki-e/install-action@shfmt
- run: printf '%s\n' "STRICT_PROVENANCE_LINTS= -Z crate-attr=feature(strict_provenance_lints) -D fuzzy_provenance_casts" >>"${GITHUB_ENV}"
if: always() && steps.pre.outputs.rust == 'true' && inputs.fuzzy_provenance_casts
- run: printf '%s\n' "RUSTFLAGS=${RUSTFLAGS} -Z crate-attr=feature(unqualified_local_imports) -D unqualified_local_imports" >>"${GITHUB_ENV}"
if: always() && steps.pre.outputs.rust == 'true' && inputs.unqualified_local_imports
- run: cat -- tools/.tidy-check-license-headers
- run: cat -- .cspell.json
- run: printf 'REMOVE_UNUSED_WORDS=1\n' >>"${GITHUB_ENV}"
if: github.repository_owner == 'taiki-e' && (github.event_name == 'schedule' || github.event_name == 'push' && github.ref == 'refs/heads/main')
- run: tools/tidy.sh
- id: diff
run: |
git config user.name 'Taiki Endo'
git config user.email 'te316e89@gmail.com'
git add -N .github/.cspell
if ! git diff --exit-code -- .github/.cspell; then
git add .github/.cspell
git commit -m "Update cspell dictionary"
printf 'success=false\n' >>"${GITHUB_OUTPUT}"
fi
if: github.repository_owner == 'taiki-e' && (github.event_name == 'schedule' || github.event_name == 'push' && github.ref == 'refs/heads/main')
- id: create-pull-request
uses: peter-evans/create-pull-request@v7
with:
title: Update cspell dictionary
body: |
Auto-generated by CI using [create-pull-request](https://github.com/peter-evans/create-pull-request).
branch: update-cspell-dictionary
token: ${{ secrets.CREATE_PR_TOKEN }}
if: github.repository_owner == 'taiki-e' && (github.event_name == 'schedule' || github.event_name == 'push' && github.ref == 'refs/heads/main') && steps.diff.outputs.success == 'false'
- name: Notify PR author by assigning PR
run: gh pr edit --add-assignee taiki-e "${PR_NUMBER:?}"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ steps.create-pull-request.outputs.pull-request-number }}
if: github.repository_owner == 'taiki-e' && (github.event_name == 'schedule' || github.event_name == 'push' && github.ref == 'refs/heads/main') && steps.diff.outputs.success == 'false'
- run: git add -N . && git diff --exit-code

clippy:
needs: prepare
if: needs.prepare.outputs.rust == 'true' && inputs.clippy
runs-on: ubuntu-latest
timeout-minutes: 60
steps:
- uses: taiki-e/checkout-action@v1
- uses: taiki-e/github-actions/install-rust@main
with:
toolchain: ${{ inputs.rust }}
component: clippy
- name: Run cargo clippy
run: |
trap -- 's=$?; printf >&2 "%s\n" "${0##*/}:${LINENO}: \`${BASH_COMMAND}\` exit with ${s}"; exit ${s}' ERR
Expand All @@ -90,14 +162,14 @@ jobs:
"$@"
}
# shellcheck disable=SC2206
args=(${{ inputs.args }})
if [[ "${{ inputs.args }}" != *"-features"* ]]; then
args=(${{ inputs.clippy-args }})
if [[ "${{ inputs.clippy-args }}" != *"-features"* ]]; then
args+=(--all-features)
fi
IFS=$'\n\t'
# metadata=$(cargo metadata --format-version=1 --no-deps)
# Handle target inputs.
input_target="${{ inputs.target }}"
input_target="${{ inputs.clippy-target }}"
targets=()
tier3_targets=()
if [[ -n "${input_target}" ]]; then
Expand All @@ -110,24 +182,27 @@ jobs:
fi
done <<<"${input_target},"
fi
if [[ -n "${RUSTFLAGS:-}" ]]; then
printf '%s\n' "+ RUSTFLAGS='${RUSTFLAGS}${STRICT_PROVENANCE_LINTS:-}' \\"
fi
if [[ -n "${RUSTDOCFLAGS:-}" ]]; then
printf '%s\n' "+ RUSTDOCFLAGS='${RUSTDOCFLAGS}' \\"
fi
export RUSTFLAGS="${RUSTFLAGS} -Z crate-attr=feature(unqualified_local_imports) -D unqualified_local_imports"
if [[ -z "${input_target}" ]] || [[ ${#targets[@]} -gt 0 ]]; then
retry rustup component add clippy
(
# core/alloc/std sets feature(strict_provenance_lints), so we cannot use
# -Z crate-attr=feature(strict_provenance_lints) when -Z build-std is needed.
export RUSTFLAGS="${RUSTFLAGS}${STRICT_PROVENANCE_LINTS:-}"
# shellcheck disable=SC2030
export RUSTFLAGS="${RUSTFLAGS} -Z crate-attr=feature(strict_provenance_lints) -D fuzzy_provenance_casts"
printf '%s\n' "+ RUSTFLAGS='${RUSTFLAGS}' \\"
set -x
cargo clippy --workspace --all-targets "${targets[@]}" "${args[@]}"
)
fi
# shellcheck disable=SC2031
if [[ -n "${RUSTFLAGS:-}" ]]; then
printf '%s\n' "+ RUSTFLAGS='${RUSTFLAGS}' \\"
fi
if [[ ${#tier3_targets[@]} -gt 0 ]]; then
retry rustup component add clippy rust-src
retry rustup component add rust-src
for target in "${tier3_targets[@]}"; do
(
set -x
Expand All @@ -147,39 +222,27 @@ jobs:
# cargo test --manifest-path="${manifest_path}" --doc "${args[@]}"
# )
# done
if: always() && steps.pre.outputs.rust == 'true' && inputs.clippy
- run: cat -- tools/.tidy-check-license-headers
if: always()
- run: cat -- .cspell.json
if: always()
- run: printf 'REMOVE_UNUSED_WORDS=1\n' >>"${GITHUB_ENV}"
if: github.repository_owner == 'taiki-e' && (github.event_name == 'schedule' || github.event_name == 'push' && github.ref == 'refs/heads/main')
- run: tools/tidy.sh
if: always()
- id: diff
run: |
git config user.name 'Taiki Endo'
git config user.email 'te316e89@gmail.com'
git add -N .github/.cspell
if ! git diff --exit-code -- .github/.cspell; then
git add .github/.cspell
git commit -m "Update cspell dictionary"
printf 'success=false\n' >>"${GITHUB_OUTPUT}"
fi
if: github.repository_owner == 'taiki-e' && (github.event_name == 'schedule' || github.event_name == 'push' && github.ref == 'refs/heads/main')
- id: create-pull-request
uses: peter-evans/create-pull-request@v7
with:
title: Update cspell dictionary
body: |
Auto-generated by CI using [create-pull-request](https://github.com/peter-evans/create-pull-request).
branch: update-cspell-dictionary
token: ${{ secrets.CREATE_PR_TOKEN }}
if: github.repository_owner == 'taiki-e' && (github.event_name == 'schedule' || github.event_name == 'push' && github.ref == 'refs/heads/main') && steps.diff.outputs.success == 'false'
- name: Notify PR author by assigning PR
run: gh pr edit --add-assignee taiki-e "${PR_NUMBER:?}"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ steps.create-pull-request.outputs.pull-request-number }}
if: github.repository_owner == 'taiki-e' && (github.event_name == 'schedule' || github.event_name == 'push' && github.ref == 'refs/heads/main') && steps.diff.outputs.success == 'false'
- run: git add -N . && git diff --exit-code
check-external-types:
needs: prepare
if: needs.prepare.outputs.rust-pub-lib == 'true' && inputs.check-external-types
uses: ./.github/workflows/check-external-types.yml
# with:
# rust: ${{ inputs.check-external-types-toolchain }}
# target: ${{ inputs.check-external-types-target }}
# args: ${{ inputs.check-external-types-args }}
deny:
needs: prepare
if: needs.prepare.outputs.rust-pub == 'true' && inputs.deny
uses: ./.github/workflows/deny.yml
with:
rust: ${{ inputs.rust }}
args: ${{ inputs.deny-args }}
docs:
needs: prepare
if: needs.prepare.outputs.rust-pub-lib == 'true' && inputs.docs
uses: ./.github/workflows/docs.yml
with:
rust: ${{ inputs.rust }}
target: ${{ inputs.docs-target }}
args: ${{ inputs.docs-args }}

0 comments on commit 5630c3f

Please sign in to comment.