unstructured/.github/workflows/codeql-analysis.yml
ryannikolaidis 1e32da6389
build: fix merge queue issues (#1654)
Closes #1482 

There are two known issues when attempting to merge PRs via merge queue:

- CodeQL fails with: 
```
Error: ref 'refs/heads/gh-readonly-queue/main/pr-968-499f37f64b27c66d4fc68446dbea519860d06cf7' not found in this repository
```

- CI.changelog fails with: 
```
Get current git ref
Error: The process '/usr/bin/git' failed with exit code [1](https://github.com/Unstructured-IO/unstructured/actions/runs/5735977683/job/15544656682#step:2:1)28
```

The error with CodeQL is a known and still [open
issue](https://github.com/github/codeql-action/issues/1572). We don't
current enforce branch protection for CodeQL, so probably our best
compromise is to simply not run this on the merge queue event. There
could be a narrow margin where some issue is introduced via merge, but
we'll still see issues on individual branches and on pushes to main, so
this is probably acceptable.

The changelog job now has a checkout step prior to paths-filter which
guarantees the git ref exists before attempting to execute the filter
action.

## Testing

Prior to this change, I was able to validate both the
[CodeQL](https://github.com/ryan-nikolaidis/unstructured/actions/runs/6414128010)
and
[changelog](https://github.com/ryan-nikolaidis/unstructured/actions/runs/6414128007/job/17414065768)
test errors

With these changes, validated that the merge queue was able to
[successfully
run](https://github.com/ryan-nikolaidis/unstructured/actions/runs/6414511843/job/17415024319)
the changelog CI job.
2023-10-05 21:58:39 +00:00

77 lines
2.9 KiB
YAML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
push:
branches: [ main ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
# known issue that codeql doesn't support merge_queue event, recommendation is to skip it on merge_queue
# https://github.com/github/codeql-action/issues/1572 and https://github.com/github/codeql-action/issues/1537
schedule:
- cron: '21 21 * * 5'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'python' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
steps:
- name: Checkout repository
uses: actions/checkout@v3
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2
# Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"