Added docs to debug using VSCode #89
Workflow file for this run
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 Coverage for PR | |
| on: [ pull_request, pull_request_target ] | |
| jobs: | |
| coverage: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: '0' | |
| - name: Run test coverage | |
| id: get_coverage | |
| env: | |
| ALLOWED_MARGIN: 0.01 | |
| MIN_COVERAGE: 70 | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y gdb-multiarch python3-dev python3-pip python3-wheel python3-setuptools git cmake gcc g++ pkg-config libglib2.0-dev gdbserver qemu-user | |
| sudo python3 -m pip install --upgrade pip | |
| echo PY_VER=`gdb -q -nx -ex "pi print('.'.join(map(str, sys.version_info[:2])))" -ex quit` >> $GITHUB_ENV | |
| echo GEF_CI_NB_CPU=`grep -c ^processor /proc/cpuinfo` >> $GITHUB_ENV | |
| echo GEF_CI_ARCH=`uname --processor` >> $GITHUB_ENV | |
| python${{ env.PY_VER }} -m pip install --user --upgrade -r tests/requirements.txt | |
| current_score=$(curl --silent https://hugsy.github.io/gef/coverage/gef_py.html | grep pc_cov | sed 's?.*<span class="pc_cov">\([^%]*\)%</span>?\1?g') | |
| bash scripts/generate-coverage-docs.sh | |
| new_score=$(cat docs/coverage/gef_py.html | grep pc_cov | sed 's?.*<span class="pc_cov">\([^%]*\)%</span>?\1?g') | |
| diff_score=$(python -c "print(${new_score} - ${current_score})") | |
| commit=$(git rev-parse HEAD) | |
| include_tests=$(git diff ${{ github.event.before }} ${{ github.event.after }} --compact-summary | egrep --count '^ tests/' || true) | |
| include_docs=$(git diff ${{ github.event.before }} ${{ github.event.after }} --compact-summary | egrep --count '^ docs/' || true) | |
| echo "commit=${commit}" >> $GITHUB_OUTPUT | |
| echo "new_coverage_score=${new_score}" >> $GITHUB_OUTPUT | |
| echo "current_coverage_score=${current_score}" >> $GITHUB_OUTPUT | |
| echo "diff_score=${diff_score}" >> $GITHUB_OUTPUT | |
| echo "include_tests=${include_tests}" >> $GITHUB_OUTPUT | |
| echo "include_docs=${include_docs}" >> $GITHUB_OUTPUT | |
| WORDS=("pycharm" "debugpy" "ptvsd" "breakpoint" "pdb") | |
| WORDS_FOUND="" | |
| for word in "${WORDS[@]}"; do | |
| if git diff ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} -- "gef.py" | grep "^+" | grep -q "$word"; then | |
| WORDS_FOUND+="'$word' " | |
| fi | |
| done | |
| echo "words_found=${WORDS_FOUND}" >> $GITHUB_OUTPUT | |
| - uses: actions/github-script@v6 | |
| env: | |
| COMMIT: ${{ steps.get_coverage.outputs.commit }} | |
| SCORE_OLD: ${{ steps.get_coverage.outputs.current_coverage_score }} | |
| SCORE_NEW: ${{ steps.get_coverage.outputs.new_coverage_score }} | |
| SCORE_DIFF: ${{ steps.get_coverage.outputs.diff_score }} | |
| WORDS_FOUND: ${{ steps.get_coverage.outputs.words_found }} | |
| with: | |
| script: | | |
| const tests_changes = ${{ steps.get_coverage.outputs.include_tests }}; | |
| const docs_changes = ${{ steps.get_coverage.outputs.include_docs }}; | |
| const forbiddenWordsString = process.env.WORDS_FOUND || ''; | |
| const forbidden_words = forbiddenWordsString.split(" ").filter(word => word.trim() !== ''); | |
| const comment = `## 🤖 Coverage Update | |
| * Commit: ${process.env.COMMIT} | |
| * Current Coverage: ${process.env.SCORE_OLD}% | |
| * New Coverage: ${process.env.SCORE_NEW}% | |
| * Diff: ${process.env.SCORE_DIFF} | |
| To this point, this PR: | |
| * ${(tests_changes == 0) ? "**does not** include" : "includes"} changes to tests | |
| * ${(docs_changes == 0) ? "**does not** include" : "includes"} changes to documentation | |
| * ${(forbidden_words.length === 0 || forbidden_words[0] === '') ? "**does not** include forbidden words" : "includes the forbidden words:" + forbidden_words.join(", ")} | |
| `; | |
| const { owner, repo, number } = context.issue; | |
| await github.rest.issues.createComment({ owner, repo, issue_number: number, body: comment }); | |
| try { | |
| if(docs_changes > 0) { | |
| await github.rest.issues.addLabels({ | |
| owner: owner, | |
| repo: repo, | |
| issue_number: number, | |
| labels: ['documentation'] | |
| }); | |
| } else { | |
| await github.rest.issues.removeLabel({ | |
| owner: owner, | |
| repo: repo, | |
| issue_number: number, | |
| name: 'documentation' | |
| }); | |
| } | |
| if(tests_changes > 0) { | |
| await github.rest.issues.addLabels({ | |
| owner: owner, | |
| repo: repo, | |
| issue_number: number, | |
| labels: ['automation/ci'] | |
| }); | |
| } else { | |
| await github.rest.issues.removeLabel({ | |
| owner: owner, | |
| repo: repo, | |
| issue_number: number, | |
| name: 'automation/ci' | |
| }); | |
| } | |
| } catch (err) {} |