Utilize GitHub Actions to aid checking of commit message #3112
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 | |
| on: | |
| push: | |
| branches: | |
| - master | |
| tags: | |
| - 'v[0-9]+.[0-9]+.[0-9]+' | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| test: | |
| strategy: | |
| matrix: | |
| platform: [ubuntu-latest, macos-latest, windows-latest] | |
| runs-on: ${{ matrix.platform }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '16' | |
| - name: Install Graphviz | |
| uses: tlylt/install-graphviz@v1 | |
| - name: Install Java | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '11' | |
| distribution: 'temurin' | |
| - run: npm run setup | |
| - run: npm run test | |
| - name: Upload coverage report to Codecov | |
| uses: codecov/codecov-action@v3 | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| check-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '16' | |
| - name: Install Graphviz | |
| uses: tlylt/install-graphviz@v1 | |
| - name: Install Java | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '11' | |
| distribution: 'temurin' | |
| - run: npm run setup | |
| - run: npm run build:web | |
| - name: Build MarkBind docs (UG + DG) | |
| run: npm run build:docs | |
| - name: Check build log | |
| run: | | |
| log_file="docs/_markbind/logs/markbind-$(date +'%Y-%m-%d').log" | |
| pattern="^[0-9T:.Z-]+ - (warn|error):" | |
| if grep -q -E "$pattern" "$log_file"; then | |
| printf "The following issues were found when building the documentation:\n" | |
| grep -E "$pattern" "$log_file" | |
| exit 1 | |
| fi | |
| deploy-docs: | |
| needs: test | |
| # disabled on forks | |
| if: github.event_name == 'push' && github.repository == 'MarkBind/markbind' | |
| runs-on: ubuntu-latest | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '16' | |
| - name: Install Graphviz | |
| uses: tlylt/install-graphviz@v1 | |
| - name: Install Java | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '11' | |
| distribution: 'temurin' | |
| - run: npm run setup | |
| - name: Deploy DG on any commit to master, to markbind.org/devdocs | |
| run: >- | |
| npm run build:web && | |
| npm run deploy:dg | |
| - name: Deploy UG on release, to markbind.org | |
| if: github.ref_type == 'tag' | |
| run: npm run deploy:ug | |
| - name: Check deploy log | |
| run: | | |
| log_file="docs/_markbind/logs/markbind-$(date +'%Y-%m-%d').log" | |
| pattern="^[0-9T:.Z-]+ - error:" | |
| if grep -q -E "$pattern" "$log_file"; then | |
| printf "The following issues were found when deploying the documentation:\n" | |
| grep -E "$pattern" "$log_file" | |
| exit 1 | |
| fi | |
| remind-pr-author: | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Preprocess PR Body with Python | |
| run: | | |
| python scripts/process_message.py "${{ github.event.pull_request.body }}" > processed_body.txt | |
| shell: bash | |
| - name: Extract Proposed Commit Message | |
| run: | | |
| processed_body=$(cat processed_body.txt) | |
| proposed_commit_message=$(echo "$processed_body" | awk '/\*\*Proposed commit message: \(wrap lines at 72 characters\)\*\*/,/\*\*Checklist:\*\* :ballot_box_with_check:/' | tail -n +2 | head -n -3) | |
| echo "Proposed commit message: $proposed_commit_message" | |
| echo "message_filled=$(echo $proposed_commit_message | grep -q '[^[:space:]]'; echo $?)" | |