Skip to content

Commit 93b2a5a

Browse files
TechassiNickLarsenNZ
Techassi
and
NickLarsenNZ
authored
ci: Add pre-commit action (#1)
* ci: Add pre-commit action * chore: Rename pre-commit action * ci: Add pre-commit workflow * chore: Update action path in workflow * fix: Add newline to yamllint config * ci: Add Rust component override to pre-commit action * chore: Add license * chore: Add run-pre-commit action to README * chore: Fix markdownlint error * chore: Apply suggestions Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com> * chore: Fix trailing-whitespace error * chore: Fix typo in run-pre-commit action --------- Co-authored-by: Nick <10092581+NickLarsenNZ@users.noreply.github.com>
1 parent d501d64 commit 93b2a5a

File tree

8 files changed

+401
-6
lines changed

8 files changed

+401
-6
lines changed

‎.github/actionlint.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
self-hosted-runner:
3+
# Ubicloud machines we are using
4+
labels:
5+
- ubicloud-standard-8-arm

‎.github/workflows/pr_pre-commit.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: pre-commit
3+
4+
on:
5+
pull_request:
6+
7+
8+
jobs:
9+
pre-commit:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
13+
with:
14+
fetch-depth: 0
15+
submodules: recursive
16+
- uses: ./run-pre-commit

‎.markdownlint.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
# All defaults or options can be checked here:
3+
# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
4+
5+
# Default state for all rules
6+
default: true
7+
8+
# MD013/line-length - Line length
9+
MD013:
10+
# Number of characters
11+
line_length: 9999
12+
# Number of characters for headings
13+
heading_line_length: 9999
14+
# Number of characters for code blocks
15+
code_block_line_length: 9999
16+
17+
# MD033/no-inline-html
18+
MD033:
19+
allowed_elements: [h1, img, p]
20+
21+
# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
22+
MD024:
23+
# Only check sibling headings
24+
siblings_only: true

‎.pre-commit-config.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
default_language_version:
3+
node: system
4+
5+
repos:
6+
- repo: https://github.com/pre-commit/pre-commit-hooks
7+
rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c # 4.6.0
8+
hooks:
9+
- id: trailing-whitespace
10+
- id: end-of-file-fixer
11+
- id: detect-aws-credentials
12+
args: ["--allow-missing-credentials"]
13+
- id: detect-private-key
14+
15+
- repo: https://github.com/adrienverge/yamllint
16+
rev: 81e9f98ffd059efe8aa9c1b1a42e5cce61b640c6 # 1.35.1
17+
hooks:
18+
- id: yamllint
19+
20+
- repo: https://github.com/igorshubovych/markdownlint-cli
21+
rev: f295829140d25717bc79368d3f966fc1f67a824f # 0.41.0
22+
hooks:
23+
- id: markdownlint
24+
- repo: https://github.com/koalaman/shellcheck-precommit
25+
rev: 2491238703a5d3415bb2b7ff11388bf775372f29 # 0.10.0
26+
hooks:
27+
- id: shellcheck
28+
args: ["--severity=info"]
29+
30+
- repo: https://github.com/rhysd/actionlint
31+
rev: 62dc61a45fc95efe8c800af7a557ab0b9165d63b # 1.7.1
32+
hooks:
33+
- id: actionlint

‎.yamllint.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
extends: default
3+
4+
rules:
5+
line-length: disable
6+
truthy:
7+
check-keys: false
8+
comments:
9+
min-spaces-from-content: 1 # Needed due to https://github.com/adrienverge/yamllint/issues/443
10+
indentation:
11+
indent-sequences: consistent

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ particular step in a workflow.
1919

2020
## `build-product-image`
2121

22-
Manifest: [build-product-image/action.yml][build-product-image]
22+
> Manifest: [build-product-image/action.yml][build-product-image]
2323
24+
<!-- markdownlint-disable-next-line MD028 -->
2425
> [!NOTE]
2526
> The build step is not concerned with registries, ports, paths to repositories, but still requires
2627
> a name. If the name does not contain a registry, `hub.docker.com` (?) is implied. Therefore,
@@ -73,7 +74,7 @@ localhost/kafka:3.4.1-stackable0.0.0-dev-amd64
7374

7475
## `publish-image`
7576

76-
Manifest: [publish-image/action.yml][publish-image]
77+
> Manifest: [publish-image/action.yml][publish-image]
7778
7879
This action signs and publishes a *single* container image to the given registry. It does the
7980
following work:
@@ -114,7 +115,7 @@ None
114115

115116
## `publish-index-manifest`
116117

117-
Manifest: [publish-index-manifest/action.yml][publish-index-manifest]
118+
> Manifest: [publish-index-manifest/action.yml][publish-index-manifest]
118119
119120
This action creates an image index manifest, publishes it, and signs it. It does the following work:
120121

@@ -142,9 +143,58 @@ None
142143

143144
[publish-index-manifest]: ./publish-index-manifest/action.yml
144145

146+
## `run-pre-commit`
147+
148+
> Manifest: [run-pre-commit/action.yml][run-pre-commit]
149+
150+
This action runs pre-commit by setting up Python and optionally the Rust toolchain and Hadolint in
151+
the requested version. It requires a checkout with depth 0. It does the following work:
152+
153+
1. Installs Python. The version can be configured via the `python-version` input.
154+
2. Optionally sets up the Rust toolchain and Hadolint.
155+
3. Runs pre-commit on changed files.
156+
157+
Example usage (workflow):
158+
159+
```yaml
160+
---
161+
name: pre-commit
162+
163+
on:
164+
pull_request:
165+
166+
jobs:
167+
pre-commit:
168+
runs-on: ubuntu-latest
169+
steps:
170+
- uses: actions/checkout
171+
with:
172+
fetch-depth: 0
173+
submodules: recursive
174+
- uses: stackabletech/actions/run-pre-commit
175+
```
176+
177+
### Inputs and Outputs
178+
179+
> [!TIP]
180+
> For descriptions of the inputs and outputs, see the complete [run-pre-commit] action.
181+
182+
#### Inputs
183+
184+
- `python-version`
185+
- `rust`
186+
- `rust-components`
187+
- `hadolint`
188+
189+
#### Outputs
190+
191+
None
192+
193+
[run-pre-commit]: ./run-pre-commit/action.yml
194+
145195
## `shard`
146196

147-
Manifest: [shard/action.yml][shard]
197+
> Manifest: [shard/action.yml][shard]
148198

149199
This action produces a list of versions for a product. This is to be used as a matrix dimension to
150200
parallelize builds. It does the following work:
@@ -160,9 +210,9 @@ jobs:
160210
name: Generate Version List
161211
runs-on: ubuntu-latest
162212
steps:
163-
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
213+
- uses: actions/checkout
164214
- id: shard
165-
uses: ./.github/actions/shard
215+
uses: stackabletech/actions/shard
166216
with:
167217
product-name: ${{ env.PRODUCT_NAME }}
168218
outputs:

0 commit comments

Comments
 (0)