Skip to content

Commit db1830e

Browse files
authored
added use-case information
1 parent 1ea5263 commit db1830e

File tree

1 file changed

+65
-2
lines changed

1 file changed

+65
-2
lines changed

README.md

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,66 @@
1-
# Kubeval Validation
1+
# Github Action: Kubeval Validation
22

3-
A GitHub Action for using Kubeval to validate your kubernetes manifests in your workflows.
3+
This GitHub Action validates Kubernetes manifest files using kubeval.
4+
5+
## Usage
6+
7+
To use this action, include the following step in your workflow:
8+
9+
```yaml
10+
- name: Validate Kubernetes Manifests
11+
uses: To be updated
12+
with:
13+
directory: 'path/to/manifests'
14+
```
15+
16+
The directory input should point to the directory containing your Kubernetes manifest files.
17+
18+
## Inputs
19+
20+
```directory (required):``` The directory containing the Kubernetes manifest files to validate.
21+
22+
## Outputs
23+
24+
```validation_result:``` The result of the Kubernetes manifest validation. It will be either "success" or "failure" based on the validation outcome.
25+
26+
## Example Workflow
27+
28+
Here's an example workflow that incorporates the Kubernetes Manifest Validation action:
29+
30+
```yaml
31+
name: CI
32+
33+
on:
34+
push:
35+
branches:
36+
- main
37+
38+
jobs:
39+
validate_manifests:
40+
runs-on: ubuntu-latest
41+
42+
steps:
43+
- name: Checkout Repository
44+
uses: actions/checkout@v2
45+
46+
- name: Validate Kubernetes Manifests
47+
uses: To be updated
48+
with:
49+
directory: 'path/to/manifests'
50+
```
51+
52+
## Author Information
53+
54+
This GitHub Action is maintained by the contributors listed on GitHub.
55+
56+
The original code of this repository is based on work done by Dhrubajyoti Chakraborty as part of the kubeval-validation GitHub Action.
57+
58+
## License
59+
60+
Licensed under the Apache License, Version 2.0 (the "License").
61+
62+
You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0.
63+
64+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" basis, without WARRANTIES or conditions of any kind, either express or implied.
65+
66+
See the License for the specific language governing permissions and limitations under the License

0 commit comments

Comments
 (0)