warn if latest release and rules are not compatible #2111
This file contains 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: CI | |
| on: | |
| push: | |
| branches: [ master ] | |
| pull_request: | |
| branches: [ master ] | |
| # trigger workflow on edited as well (opened and synchronize are default) | |
| types: [opened, edited, synchronize] | |
| workflow_dispatch: | |
| inputs: | |
| thorough: | |
| description: 'lint --thorough' | |
| type: boolean | |
| required: true | |
| schedule: | |
| # run every week at 04:05 on Sunday | |
| - cron: '5 4 * * 0' | |
| # save workspaces to speed up testing | |
| env: | |
| CAPA_SAVE_WORKSPACE: "True" | |
| jobs: | |
| rule_linter: | |
| runs-on: ubuntu-20.04 | |
| env: | |
| # expect this text in the PR body to trigger thorough lint of all rules | |
| LINT_THOROUGH: '[x] lint thorough all' | |
| steps: | |
| # We check the submodules separately as the rules submodule's reference may not be our PR/master | |
| - name: Checkout capa without submodules | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| repository: mandiant/capa | |
| - name: Checkout capa-rules | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| path: rules | |
| - name: Checkout capa-testfiles | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| repository: mandiant/capa-testfiles | |
| path: tests/data | |
| # use latest available python for best performance | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0 | |
| with: | |
| python-version: 3.11 | |
| - name: Install capa | |
| run: pip install -e . | |
| # Regular lint is fast, so do this first | |
| - name: Run regular lint on all rules | |
| run: python scripts/lint.py rules/ | |
| # Then run thorough lint | |
| - name: Get modified files | |
| if: github.event_name != 'workflow_dispatch' && github.event_name != 'schedule' | |
| id: files | |
| uses: Ana06/get-changed-files@25f79e676e7ea1868813e21465014798211fad8c # v2.3.0 | |
| # this Action may throw the below error, e.g. when not properly rebased | |
| # however, it still gets the modified files and we can continue | |
| # Error: The head commit for this pull_request event is not ahead of the base commit. | |
| continue-on-error: true | |
| - name: Check PR text body contains LINT_THOROUGH | |
| if: github.event_name != 'workflow_dispatch' && github.event_name != 'schedule' | |
| id: lint_thorough | |
| env: | |
| PR_BODY: ${{ github.event.pull_request.body }} | |
| # grep returns 0 (success) if string is found | |
| run: echo $PR_BODY | grep -qiF "$LINT_THOROUGH" | |
| # otherwise not finding LINT_THOROUGH would fail this step | |
| continue-on-error: true | |
| - name: Run thorough lint on all rule files | |
| # if $LINT_THOROUGH is provided in the PR body, manual run specifies it, or this is a scheduled run | |
| if: github.event_name != 'workflow_dispatch' && github.event_name != 'schedule' && steps.lint_thorough.outcome == 'success' || github.event_name == 'workflow_dispatch' && github.event.inputs.thorough == 'true' || github.event_name == 'schedule' | |
| run: python scripts/lint.py --thorough -v rules/ | |
| - name: Run thorough lint on modified rule files | |
| # otherwise only lint modified rules thoroughly | |
| if: github.event_name != 'workflow_dispatch' && github.event_name != 'schedule' && steps.lint_thorough.outcome != 'success' | |
| run: | | |
| cd rules/ | |
| for changed_file in ${{ steps.files.outputs.added_modified }} ${{ steps.files.outputs.renamed }}; do | |
| if [[ ! $changed_file =~ .git|.md ]]; then | |
| tag=$(grep '\sname:' $changed_file | sed 's/^.*: //') | |
| python ../scripts/lint.py --thorough -t "$tag" -v . | |
| fi | |
| done | |
| - name: Check feature overlaps on modified rules | |
| run: | | |
| cd rules/ | |
| for changed_file in ${{ steps.files.outputs.added_modified }} ${{ steps.files.outputs.renamed }}; do | |
| if [[ ! $changed_file =~ (.git|.md) ]]; then | |
| python ../scripts/detect_duplicate_features.py . "$changed_file" | |
| fi | |
| done | |
| continue-on-error: true | |
| # warn if new rules are not compatible with latest release | |
| rules_latest_release: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Get latest release executable name and version | |
| run: | | |
| v=$(curl -s https://api.github.com/repos/mandiant/capa/releases/latest | jq .name | tr -d '"') | |
| echo "zip_name=capa-$v-linux.zip" >> $GITHUB_ENV | |
| - name: Checkout capa-rules | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| path: rules | |
| - name: Checkout capa-testfiles | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| repository: mandiant/capa-testfiles | |
| path: tests/data | |
| - name: Fetch latest capa release executable | |
| uses: robinraju/release-downloader@a96f54c1b5f5e09e47d9504526e96febd949d4c2 # v1.11 | |
| with: | |
| repository: "mandiant/capa" | |
| latest: true | |
| fileName: ${{ env.zip_name }} | |
| - name: Unzip | |
| run: unzip ${{ env.zip_name }} -d latest-release | |
| - name: Run latest release with current rules | |
| run: latest-release/capa -r rules/ tests/data/9324d1a8ae37a36ae560c37448c9705a.exe_ |