chore: add documentation check to pre-commit #10
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: main | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| types: [opened, synchronize] | |
| concurrency: | |
| group: github.head_ref | |
| cancel-in-progress: true | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| name: lint | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: JohnnyMorganz/stylua-action@v2 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| version: latest | |
| args: --check . | |
| documentation: | |
| runs-on: ubuntu-latest | |
| name: documentation | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 2 | |
| - name: setup neovim | |
| uses: rhysd/action-setup-vim@v1 | |
| with: | |
| neovim: true | |
| version: v0.9.1 | |
| - name: generate documentation | |
| run: make documentation-ci | |
| - name: check docs diff | |
| run: exit $(git status --porcelain doc | wc -l | tr -d " ") | |
| tests: | |
| needs: | |
| - lint | |
| - documentation | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 2 | |
| strategy: | |
| matrix: | |
| neovim_version: ['v0.7.2', 'v0.8.3', 'v0.9.1', 'nightly'] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - run: date +%F > todays-date | |
| - name: restore cache for today's nightly. | |
| uses: actions/cache@v3 | |
| with: | |
| path: _neovim | |
| key: ${{ runner.os }}-x64-${{ hashFiles('todays-date') }} | |
| - name: setup neovim | |
| uses: rhysd/action-setup-vim@v1 | |
| with: | |
| neovim: true | |
| version: ${{ matrix.neovim_version }} | |
| - name: run tests | |
| run: make test-ci | |
| release: | |
| name: release | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| needs: | |
| - tests | |
| runs-on: ubuntu-latest | |
| # From https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions | |
| permissions: | |
| actions: read | |
| checks: write | |
| contents: write | |
| deployments: none | |
| id-token: none | |
| issues: write | |
| discussions: write | |
| packages: write | |
| pages: write | |
| pull-requests: write | |
| repository-projects: write | |
| security-events: write | |
| statuses: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: google-github-actions/release-please-action@v3 | |
| id: release | |
| with: | |
| release-type: simple | |
| package-name: keyseer.nvim | |
| - name: tag stable versions | |
| if: ${{ steps.release.outputs.release_created }} | |
| run: | | |
| git config user.name github-actions[bot] | |
| git config user.email github-actions[bot]@users.noreply.github.com | |
| git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/google-github-actions/release-please-action.git" | |
| git tag -d stable || true | |
| git push origin :stable || true | |
| git tag -a stable -m "Last Stable Release" | |
| git push origin stable |