Skip to content

Commit 36054fb

Browse files
committed
chore(template): Add TODO comments to build workflow
1 parent cab6673 commit 36054fb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

template/.github/workflows/build.yml.j2

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ jobs:
155155
with:
156156
key: clippy
157157
cache-all-crates: "true"
158+
# TODO (@Techassi): Remove this step (unmaintained action, kinda useless step anyway)
158159
- name: Run clippy action to produce annotations
159160
uses: giraffate/clippy-action@13b9d32482f25d29ead141b79e7e04e7900281e0 # v1.0.1
160161
env:
@@ -164,12 +165,14 @@ jobs:
164165
clippy_flags: --all-targets -- -D warnings
165166
reporter: 'github-pr-review'
166167
github_token: ${{ secrets.GITHUB_TOKEN }}
168+
# TODO (@Techassi): Remove, done by pre-commit
167169
- name: Run clippy manually without annotations
168170
env:
169171
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
170172
if: env.GITHUB_TOKEN == null
171173
run: cargo clippy --color never -q --all-targets -- -D warnings
172174

175+
# TODO (@Techassi): Can be done by pre-commit
173176
run_rustdoc:
174177
name: Run RustDoc
175178
runs-on: ubuntu-latest
@@ -192,6 +195,7 @@ jobs:
192195
cache-all-crates: "true"
193196
- run: cargo doc --document-private-items
194197

198+
# TODO (@Techassi): Remove, done by pre-commit
195199
run_tests:
196200
name: Run Cargo Tests
197201
runs-on: ubuntu-latest
@@ -304,6 +308,8 @@ jobs:
304308
- name: log
305309
run: echo All tests have passed!
306310

311+
# TODO (@Techassi): Most of these publishing and signing tasks can be done by our own actions.
312+
# Make use of them just like we do in docker-images.
307313
package_and_publish:
308314
name: Package Charts, Build Docker Image and publish them - ${{ matrix.runner }}
309315
needs:

0 commit comments

Comments
 (0)