Skip to content

Commit 68d09df

Browse files
tdsteintdstein
committed
style: add name and double line break to each step
1 parent b61e2db commit 68d09df

File tree

6 files changed

+175
-62
lines changed

6 files changed

+175
-62
lines changed

‎.github/workflows/board.yaml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ jobs:
1414
permissions:
1515
issues: write
1616
steps:
17-
- run: gh issue edit "$NUMBER" --add-label "$LABELS"
17+
- name: Add label to issue
18+
run: gh issue edit "$NUMBER" --add-label "$LABELS"
1819
env:
1920
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2021
GH_REPO: ${{ github.repository }}
2122
NUMBER: ${{ github.event.issue.number }}
2223
LABELS: sdk
23-
- uses: actions/[email protected]
24+
25+
- name: Add issue to project board
26+
uses: actions/[email protected]
2427
continue-on-error: true
2528
with:
2629
project-url: https://github.com/orgs/rstudio/projects/207

‎.github/workflows/ci.yaml‎

Lines changed: 73 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,23 @@ jobs:
88
lint:
99
runs-on: ubuntu-latest
1010
steps:
11-
- uses: actions/checkout@v4
12-
- uses: astral-sh/setup-uv@v3
13-
- run: uv python install
14-
- run: make dev
15-
- run: make lint
16-
- run: make fmt
11+
- name: Checkout code
12+
uses: actions/checkout@v4
13+
14+
- name: Setup UV
15+
uses: astral-sh/setup-uv@v3
16+
17+
- name: Install UV Python
18+
run: uv python install
19+
20+
- name: Setup development environment
21+
run: make dev
22+
23+
- name: Run linter
24+
run: make lint
25+
26+
- name: Format code
27+
run: make fmt
1728

1829
test:
1930
runs-on: ubuntu-latest
@@ -28,19 +39,31 @@ jobs:
2839
- "3.12"
2940
- "3.13"
3041
steps:
31-
- uses: actions/checkout@v4
32-
- uses: astral-sh/setup-uv@v3
33-
- run: uv python install ${{ matrix.python-version }}
34-
- run: make dev
35-
- run: make test
42+
- name: Checkout code
43+
uses: actions/checkout@v4
44+
45+
- name: Setup UV
46+
uses: astral-sh/setup-uv@v3
47+
48+
- name: Install UV Python for matrix version
49+
run: uv python install ${{ matrix.python-version }}
50+
51+
- name: Setup development environment
52+
run: make dev
53+
54+
- name: Run tests
55+
run: make test
3656

3757
setup-integration-test:
3858
runs-on: ubuntu-latest
3959
outputs:
4060
versions: ${{ steps.versions.outputs.versions }}
4161
steps:
42-
- uses: actions/checkout@v4
43-
- id: versions
62+
- name: Checkout code
63+
uses: actions/checkout@v4
64+
65+
- name: Get integration versions
66+
id: versions
4467
working-directory: ./integration
4568
# The `jq` command is "output compact, raw input, slurp, split on new lines, and remove the last element". This results in a JSON array of Connect versions (e.g., ["2025.01.0", "2024.12.0"]).
4669
run: |
@@ -55,16 +78,28 @@ jobs:
5578
matrix:
5679
CONNECT_VERSION: ${{ fromJson(needs.setup-integration-test.outputs.versions) }}
5780
steps:
58-
- uses: actions/checkout@v4
59-
- uses: docker/setup-buildx-action@v3
81+
- name: Checkout code
82+
uses: actions/checkout@v4
83+
84+
- name: Setup Docker Buildx
85+
uses: docker/setup-buildx-action@v3
86+
6087
- name: Write Posit Connect license to disk
6188
run: echo "$CONNECT_LICENSE" > ./integration/license.lic
6289
env:
6390
CONNECT_LICENSE: ${{ secrets.CONNECT_LICENSE }}
64-
- uses: astral-sh/setup-uv@v3
65-
- run: uv python install
66-
- run: make -C ./integration ${{ matrix.CONNECT_VERSION }}
67-
- uses: actions/upload-artifact@v4
91+
92+
- name: Setup UV
93+
uses: astral-sh/setup-uv@v3
94+
95+
- name: Install UV Python
96+
run: uv python install
97+
98+
- name: Run integration tests for version
99+
run: make -C ./integration ${{ matrix.CONNECT_VERSION }}
100+
101+
- name: Upload integration test report
102+
uses: actions/upload-artifact@v4
68103
if: always()
69104
with:
70105
name: ${{ matrix.CONNECT_VERSION }} - Integration Test Report
@@ -78,10 +113,13 @@ jobs:
78113
pull-requests: write
79114
if: always()
80115
steps:
81-
- uses: actions/download-artifact@v4
116+
- name: Download artifacts
117+
uses: actions/download-artifact@v4
82118
with:
83119
path: artifacts
84-
- uses: EnricoMi/publish-unit-test-result-action@v2
120+
121+
- name: Publish integration test results
122+
uses: EnricoMi/publish-unit-test-result-action@v2
85123
with:
86124
check_name: integration-test-results
87125
comment_mode: off
@@ -91,8 +129,17 @@ jobs:
91129
build:
92130
runs-on: ubuntu-latest
93131
steps:
94-
- uses: actions/checkout@v4
95-
- uses: astral-sh/setup-uv@v3
96-
- run: uv python install
97-
- run: make dev
98-
- run: make build
132+
- name: Checkout code
133+
uses: actions/checkout@v4
134+
135+
- name: Setup UV
136+
uses: astral-sh/setup-uv@v3
137+
138+
- name: Install UV Python
139+
run: uv python install
140+
141+
- name: Setup development environment
142+
run: make dev
143+
144+
- name: Build project
145+
run: make build

‎.github/workflows/conventional-commits.yaml‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ jobs:
99
default:
1010
runs-on: ubuntu-latest
1111
steps:
12-
- uses: amannn/action-semantic-pull-request@v5
12+
- name: Lint pull request title
13+
uses: amannn/action-semantic-pull-request@v5
1314
id: lint
1415
env:
1516
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -25,7 +26,9 @@ jobs:
2526
style
2627
refactor
2728
test
28-
- uses: marocchino/sticky-pull-request-comment@v2
29+
30+
- name: Post lint error comment
31+
uses: marocchino/sticky-pull-request-comment@v2
2932
if: always() && (steps.lint.outputs.error_message != null)
3033
with:
3134
header: lint-error
@@ -39,7 +42,9 @@ jobs:
3942
```
4043
${{ steps.lint.outputs.error_message }}
4144
```
42-
- if: ${{ steps.lint.outputs.error_message == null }}
45+
46+
- name: Remove lint error comment
47+
if: ${{ steps.lint.outputs.error_message == null }}
4348
uses: marocchino/sticky-pull-request-comment@v2
4449
with:
4550
header: lint-error

‎.github/workflows/coverage.yaml‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,26 @@ jobs:
88
cov:
99
runs-on: ubuntu-latest
1010
steps:
11-
- uses: actions/checkout@v4
12-
- uses: astral-sh/setup-uv@v3
13-
- run: uv python install
14-
- run: make dev
15-
- run: make test
16-
- run: make cov-xml
17-
- if: ${{ ! github.event.pull_request.head.repo.fork }}
11+
- name: Checkout code
12+
uses: actions/checkout@v4
13+
14+
- name: Setup UV
15+
uses: astral-sh/setup-uv@v3
16+
17+
- name: Install UV Python
18+
run: uv python install
19+
20+
- name: Setup development environment
21+
run: make dev
22+
23+
- name: Run tests
24+
run: make test
25+
26+
- name: Generate coverage report
27+
run: make cov-xml
28+
29+
- name: Upload coverage report
30+
if: ${{ ! github.event.pull_request.head.repo.fork }}
1831
uses: orgoro/[email protected]
1932
with:
2033
coverageFile: coverage.xml

‎.github/workflows/release.yaml‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,26 @@ jobs:
99
permissions:
1010
id-token: write
1111
steps:
12-
- uses: actions/checkout@v4
12+
- name: Checkout code
13+
uses: actions/checkout@v4
1314
with:
1415
fetch-depth: 0
15-
- uses: astral-sh/setup-uv@v3
16-
- run: uv python install
17-
- uses: actions/setup-node@v4
18-
- run: make build
19-
- run: make install
20-
- id: release
16+
17+
- name: Setup UV
18+
uses: astral-sh/setup-uv@v3
19+
20+
- name: Install UV Python
21+
run: uv python install
22+
23+
- name: Setup Node.js
24+
uses: actions/setup-node@v4
25+
26+
- name: Build project
27+
run: make build
28+
29+
- name: Install project
30+
run: make install
31+
32+
- name: Publish to PyPI
33+
id: release
2134
uses: pypa/gh-action-pypi-publish@release/v1

‎.github/workflows/site.yaml‎

Lines changed: 49 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,34 +19,66 @@ jobs:
1919
if: github.event_name == 'push'
2020
runs-on: ubuntu-latest
2121
steps:
22-
- uses: actions/checkout@v4
22+
- name: Checkout code
23+
uses: actions/checkout@v4
2324
with:
2425
fetch-depth: 0
25-
- uses: astral-sh/setup-uv@v3
26-
- run: uv python install
27-
- run: make build install
28-
- uses: quarto-dev/quarto-actions/setup@v2
29-
- run: make docs
30-
- uses: actions/configure-pages@v3
31-
- uses: actions/upload-pages-artifact@v3
26+
27+
- name: Setup UV
28+
uses: astral-sh/setup-uv@v3
29+
30+
- name: Install UV Python
31+
run: uv python install
32+
33+
- name: Build and install project
34+
run: make build install
35+
36+
- name: Setup Quarto
37+
uses: quarto-dev/quarto-actions/setup@v2
38+
39+
- name: Build documentation
40+
run: make docs
41+
42+
- name: Configure GitHub Pages
43+
uses: actions/configure-pages@v3
44+
45+
- name: Upload documentation to Pages artifact
46+
uses: actions/upload-pages-artifact@v3
3247
with:
3348
path: "./docs/_site"
34-
- uses: actions/deploy-pages@v4
49+
50+
- name: Deploy to GitHub Pages
51+
uses: actions/deploy-pages@v4
3552

3653
preview:
3754
if: github.event_name == 'pull_request'
3855
runs-on: ubuntu-latest
3956
steps:
40-
- uses: actions/checkout@v4
57+
- name: Checkout code
58+
uses: actions/checkout@v4
4159
with:
4260
fetch-depth: 0
43-
- uses: astral-sh/setup-uv@v3
44-
- run: uv python install
45-
- uses: actions/setup-node@v4
46-
- uses: quarto-dev/quarto-actions/setup@v2
47-
- run: make dev
48-
- run: make docs
49-
- id: preview
61+
62+
- name: Setup UV
63+
uses: astral-sh/setup-uv@v3
64+
65+
- name: Install UV Python
66+
run: uv python install
67+
68+
- name: Setup Node.js
69+
uses: actions/setup-node@v4
70+
71+
- name: Setup Quarto
72+
uses: quarto-dev/quarto-actions/setup@v2
73+
74+
- name: Setup development environment
75+
run: make dev
76+
77+
- name: Build documentation
78+
run: make docs
79+
80+
- name: Deploy preview to Netlify
81+
id: preview
5082
working-directory: docs
5183
env:
5284
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}

0 commit comments

Comments
 (0)