docs: clarify project identity and publish "what this is" #52
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
| # SPDX-License-Identifier: AGPL-3.0-or-later | |
| name: Code Quality | |
| on: [push, pull_request] | |
| permissions: read-all | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Check file permissions | |
| run: | | |
| find . -type f -perm /111 -name "*.sh" | head -10 || true | |
| - name: Check for secrets | |
| uses: trufflesecurity/trufflehog@05cccb53bc9e13bc6d17997db5a6bcc3df44bf2f # v3.88.3 | |
| with: | |
| path: ./ | |
| base: ${{ github.event.pull_request.base.sha || github.event.before }} | |
| head: ${{ github.sha }} | |
| continue-on-error: true | |
| - name: Check TODO/FIXME | |
| run: | | |
| echo "=== TODOs ===" | |
| grep -rn "TODO\|FIXME\|HACK\|XXX" --include="*.rs" --include="*.res" --include="*.ex" . | head -20 || echo "None found" | |
| - name: Check for large files | |
| run: | | |
| find . -type f -size +1M -not -path "./.git/*" | head -10 || echo "No large files" | |
| - name: EditorConfig check | |
| uses: editorconfig-checker/action-editorconfig-checker@8554b7ea95a8de64c3b7c22e5da8da9a3e5a3aba # v2.0.0 | |
| continue-on-error: true | |
| docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Check documentation | |
| run: | | |
| MISSING="" | |
| [ ! -f "README.md" ] && [ ! -f "README.adoc" ] && MISSING="$MISSING README" | |
| [ ! -f "LICENSE" ] && [ ! -f "LICENSE.txt" ] && [ ! -f "LICENSE.md" ] && MISSING="$MISSING LICENSE" | |
| [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ] && MISSING="$MISSING CONTRIBUTING" | |
| if [ -n "$MISSING" ]; then | |
| echo "::warning::Missing docs:$MISSING" | |
| else | |
| echo "Core documentation present" | |
| fi |