vhdl-style-guide/.github/workflows/main.yml at 938d464a8a10d6c127c554e0a5d22a9d3fe12a3c · jeremiah-c-leary/vhdl-style-guide · 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# This is a basic workflow to help you get started with Actions

name: CI

# Controls when the action will run.
on:
  # Triggers the workflow on push or pull request events but only for the master branch
  push:
  pull_request:

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

env:
  BUILD_PYTHON_FOR_BUILD: "3.10"
  BUILD_PYTHON_FOR_BUILD_ALIAS: "py310"
  SKIP_TEST_ON_GITHUB: "True"

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  dist:
    name: dist
    runs-on: ubuntu-22.04

    steps:
      - name: checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0  # cannot be shallow as version will not be generated
      - name: python.install
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.BUILD_PYTHON_FOR_BUILD }}
      - name: dependencies.install
        run: |
          python -m pip install --upgrade pip
          python -m pip install tox
      - name: dist
        run: |
          tox -e wheel-${{ env.BUILD_PYTHON_FOR_BUILD_ALIAS }}
      - name: archive.upload
        uses: actions/upload-artifact@v4
        with:
          name: dist
          path: |
            dist/wheel-${{ env.BUILD_PYTHON_FOR_BUILD_ALIAS }}

  style:
    runs-on: ubuntu-22.04

    steps:
      - name: checkout
        uses: actions/checkout@v4
      - name: python.install
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.BUILD_PYTHON_FOR_BUILD }}
      - name: dependencies.install
        run: |
          python -m pip install --upgrade pip
          python -m pip install tox
      - name: test
        run: |
          tox -e style

  docs:
    runs-on: ubuntu-22.04

    steps:
      - name: checkout
        uses: actions/checkout@v4
      - name: python.install
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.BUILD_PYTHON_FOR_BUILD }}
      - name: dependencies.install
        run: |
          python -m pip install --upgrade pip
          python -m pip install tox
      - name: build
        run: |
          tox -e docs
      - name: archive.upload
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: |
            build.out/docs

  build:
    name: ${{ matrix.python-version }}-build
    runs-on: ubuntu-22.04
    strategy:
      matrix:
        python-version:
          - "3.8"
          - "3.9"
          - "3.10"
          - "3.11"
          - "3.12"
          - "3.13"

    steps:
      - name: checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
      - name: python.install ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: dependencies.install
        run: |
          python -m pip install --upgrade pip
          python -m pip install tox
      - name: build
        run: |
          tox
      - name: Upload Coverage to Codecov
        uses: codecov/codecov-action@v4
        with:
          directory: build.out
      - name: archive.upload
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: build.out-${{ matrix.python-version }}
          path: |
            build.out
#      - name: SonarCloud Scan
#        uses: SonarSource/sonarcloud-github-action@master
#        env:
#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
#          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}