docstringify/.github/workflows/ci.yml at main · stefmolin/docstringify · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# This workflow builds docstringify on Mac, Linux, and Windows for
# multiple versions of Python to confirm it can be properly installed.
#
# Based on https://github.com/stefmolin/data-morph/blob/main/.github/workflows/ci.yml
#
# Author: Stefanie Molin

name: CI

on:
  push:
    branches: [ "main" ]
    paths:
      - '**'
      - '!.github/**'
      - '.github/workflows/ci.yml'
    tags: [ "v*" ]

  pull_request:
    paths:
      - '**'
      - '!.github/**'
      - '.github/workflows/ci.yml'

  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  build:
    name: Build with Python ${{ matrix.python-version }} on ${{ matrix.os }}

    # The type of runner that the job will run on
    runs-on: ${{ matrix.os }}

    defaults:
      run:
        shell: bash -e {0}

    strategy:
        fail-fast: false
        matrix:
            os: [macos-latest, ubuntu-latest, windows-latest]
            python-version: ["3.11", "3.12", "3.13"]

    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c  # v6.0.0
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install docstringify
        run: |
          python -m pip install --upgrade pip
          python -m pip install setuptools --upgrade
          python -m pip install .

      - name: Check entry point
        run: docstringify --version

      - name: Install dev dependencies
        run: python -m pip install --group dev

      - name: Check that the docstringify-edit pre-commit hook is available
        run: pre-commit try-repo . docstringify-edit

      - name: Check that the docstringify-suggest pre-commit hook is available
        run: pre-commit try-repo . docstringify-suggest

      # this is the only hook that works without an additional arg so we can test it like this
      - name: Validate the docstringify-check pre-commit hook
        run: pre-commit try-repo . docstringify-check --all-files