Skip to content

Commit c7f8490

Browse files
authored
fix: Github -> GitHub (#340)
Signed-off-by: George Gaál <[email protected]>
1 parent e65429b commit c7f8490

File tree

15 files changed

+43
-43
lines changed

15 files changed

+43
-43
lines changed
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
title: "Github Action"
2+
title: "GitHub Action"
33
date: 2021-07-02T00:00:00Z
44
draft: false
55
tags: ["Kubeconform", "Usage"]
66
weight: 6
77
---
88

9-
Kubeconform is publishes Docker Images to Github's new Container Registry, ghcr.io. These images
10-
can be used directly in a Github Action, once logged in using a [_Github Token_](https://github.blog/changelog/2021-03-24-packages-container-registry-now-supports-github_token/).
9+
Kubeconform is publishes Docker Images to GitHub's new Container Registry, ghcr.io. These images
10+
can be used directly in a GitHub Action, once logged in using a [_GitHub Token_](https://github.blog/changelog/2021-03-24-packages-container-registry-now-supports-github_token/).
1111

1212
{{< prism >}}name: kubeconform
1313
on: push
1414
jobs:
1515
kubeconform:
1616
runs-on: ubuntu-latest
1717
steps:
18-
- name: login to Github Packages
18+
- name: login to GitHub Packages
1919
run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin
2020
- uses: actions/checkout@v2
2121
- uses: docker://ghcr.io/yannh/kubeconform:master
@@ -24,8 +24,8 @@ jobs:
2424
args: "-summary -output json kubeconfigs/"
2525
{{< /prism >}}
2626

27-
_Note on pricing_: Kubeconform relies on Github Container Registry which is currently in Beta. During that period,
27+
_Note on pricing_: Kubeconform relies on GitHub Container Registry which is currently in Beta. During that period,
2828
[bandwidth is free](https://docs.github.com/en/packages/guides/about-github-container-registry). After that period,
29-
bandwidth costs might be applicable. Since bandwidth from Github Packages within Github Actions is free, I expect
30-
Github Container Registry to also be usable for free within Github Actions in the future. If that were not to be the
29+
bandwidth costs might be applicable. Since bandwidth from GitHub Packages within GitHub Actions is free, I expect
30+
GitHub Container Registry to also be usable for free within GitHub Actions in the future. If that were not to be the
3131
case, I might publish the Docker image to a different platform.

site/public/about/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<div id=main-container><div id=header>
99
<ul id=navigation>
1010
<li><a href=/about>About</a></li>
11-
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
11+
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
1212
<li><a href=/docs/installation/>Docs</a></li>
1313
<li><a href=/>Home</a></li>
1414
</ul>

site/public/docs/crd-support/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<div id=main-container><div id=header>
99
<ul id=navigation>
1010
<li><a href=/about>About</a></li>
11-
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
11+
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
1212
<li><a href=/docs/installation/>Docs</a></li>
1313
<li><a href=/>Home</a></li>
1414
</ul>
@@ -21,7 +21,7 @@ <h2>A fast Kubernetes manifests validator</h2>
2121
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
2222
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
2323
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
24-
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
24+
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
2525
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
2626
</ul>
2727
<div id=main>

site/public/docs/index.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ For example, for Linux on x86_64 architecture:
55
curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - &amp;&amp; \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform
66
Windows Download the latest release from our release page.</description></item><item><title>Usage</title><link>http://kubeconform.mandragor.org/docs/usage/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/usage/</guid><description>$ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate.</description></item><item><title>Custom Resources support</title><link>http://kubeconform.mandragor.org/docs/crd-support/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/crd-support/</guid><description>When the -schema-location parameter is not used, or set to &amp;ldquo;default&amp;rdquo;, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found.
77
If the -schema-location value does not end with &amp;lsquo;.json&amp;rsquo;, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema.</description></item><item><title>OpenAPI to JSON Schema conversion</title><link>http://kubeconform.mandragor.org/docs/json-schema-conversion/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/json-schema-conversion/</guid><description>Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it:
8-
#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}).</description></item><item><title>Github Action</title><link>http://kubeconform.mandragor.org/docs/usage-as-github-action/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/usage-as-github-action/</guid><description>Kubeconform is publishes Docker Images to Github&amp;rsquo;s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token.
9-
name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta.</description></item><item><title>Kubeconform as a Go module</title><link>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</guid><description>Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged.
8+
#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}).</description></item><item><title>GitHub Action</title><link>http://kubeconform.mandragor.org/docs/usage-as-github-action/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/usage-as-github-action/</guid><description>Kubeconform is publishes Docker Images to GitHub&amp;rsquo;s new Container Registry, ghcr.io. These images can be used directly in a GitHub Action, once logged in using a GitHub Token.
9+
name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to GitHub Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on GitHub Container Registry which is currently in Beta.</description></item><item><title>Kubeconform as a Go module</title><link>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>http://kubeconform.mandragor.org/docs/using-as-a-go-module/</guid><description>Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged.
1010
Kubeconform contains a package that can be used as a library. An example of usage can be found in examples/main.go
1111
Additional documentation on pkg.go.dev</description></item></channel></rss>

site/public/docs/installation/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<div id=main-container><div id=header>
99
<ul id=navigation>
1010
<li><a href=/about>About</a></li>
11-
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
11+
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
1212
<li><a href=/docs/installation/>Docs</a></li>
1313
<li><a href=/>Home</a></li>
1414
</ul>
@@ -21,7 +21,7 @@ <h2>A fast Kubernetes manifests validator</h2>
2121
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
2222
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
2323
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
24-
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
24+
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
2525
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
2626
</ul>
2727
<div id=main>

site/public/docs/json-schema-conversion/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<div id=main-container><div id=header>
99
<ul id=navigation>
1010
<li><a href=/about>About</a></li>
11-
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
11+
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
1212
<li><a href=/docs/installation/>Docs</a></li>
1313
<li><a href=/>Home</a></li>
1414
</ul>
@@ -21,13 +21,13 @@ <h2>A fast Kubernetes manifests validator</h2>
2121
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
2222
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
2323
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
24-
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
24+
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
2525
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
2626
</ul>
2727
<div id=main>
2828
<div class=navig>
2929
<a href=http://kubeconform.mandragor.org/docs/crd-support/ id=prev>&lt; Custom Resources support</a>
30-
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=next>Github Action ></a>
30+
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=next>GitHub Action ></a>
3131
</div>
3232
<div id=content-text>
3333
<h1>OpenAPI to JSON Schema conversion</h1>
@@ -47,7 +47,7 @@ <h1>OpenAPI to JSON Schema conversion</h1>
4747
</div>
4848
<div class=navig>
4949
<a href=http://kubeconform.mandragor.org/docs/crd-support/ id=prev>&lt; Custom Resources support</a>
50-
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=next>Github Action ></a>
50+
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=next>GitHub Action ></a>
5151
</div>
5252
<script defer src=/js/prism.js></script>
5353
</div>

site/public/docs/usage-as-github-action/index.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
<meta charset=utf-8>
33
<meta name=author content="Yann Hamon">
44
<link rel=stylesheet type=text/css href=/css/style.css><link rel=stylesheet type=text/css href=/css/prism.css>
5-
<title>Kubeconform - Fast Kubernetes manifests validation! | Github Action</title>
5+
<title>Kubeconform - Fast Kubernetes manifests validation! | GitHub Action</title>
66
</head>
77
<body>
88
<div id=main-container><div id=header>
99
<ul id=navigation>
1010
<li><a href=/about>About</a></li>
11-
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
11+
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
1212
<li><a href=/docs/installation/>Docs</a></li>
1313
<li><a href=/>Home</a></li>
1414
</ul>
@@ -21,7 +21,7 @@ <h2>A fast Kubernetes manifests validator</h2>
2121
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
2222
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
2323
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
24-
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
24+
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
2525
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
2626
</ul>
2727
<div id=main>
@@ -30,27 +30,27 @@ <h2>A fast Kubernetes manifests validator</h2>
3030
<a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/ id=next>Kubeconform as a Go module ></a>
3131
</div>
3232
<div id=content-text>
33-
<h1>Github Action</h1>
34-
<p>Kubeconform is publishes Docker Images to Github&rsquo;s new Container Registry, ghcr.io. These images
35-
can be used directly in a Github Action, once logged in using a <a href=https://github.blog/changelog/2021-03-24-packages-container-registry-now-supports-github_token/><em>Github Token</em></a>.</p>
33+
<h1>GitHub Action</h1>
34+
<p>Kubeconform is publishes Docker Images to GitHub&rsquo;s new Container Registry, ghcr.io. These images
35+
can be used directly in a GitHub Action, once logged in using a <a href=https://github.blog/changelog/2021-03-24-packages-container-registry-now-supports-github_token/><em>GitHub Token</em></a>.</p>
3636
<pre><code class=language-bash>name: kubeconform
3737
on: push
3838
jobs:
3939
kubeconform:
4040
runs-on: ubuntu-latest
4141
steps:
42-
- name: login to Github Packages
42+
- name: login to GitHub Packages
4343
run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin
4444
- uses: actions/checkout@v2
4545
- uses: docker://ghcr.io/yannh/kubeconform:master
4646
with:
4747
entrypoint: '/kubeconform'
4848
args: "-summary -output json kubeconfigs/"
4949
</code></pre>
50-
<p><em>Note on pricing</em>: Kubeconform relies on Github Container Registry which is currently in Beta. During that period,
50+
<p><em>Note on pricing</em>: Kubeconform relies on GitHub Container Registry which is currently in Beta. During that period,
5151
<a href=https://docs.github.com/en/packages/guides/about-github-container-registry>bandwidth is free</a>. After that period,
52-
bandwidth costs might be applicable. Since bandwidth from Github Packages within Github Actions is free, I expect
53-
Github Container Registry to also be usable for free within Github Actions in the future. If that were not to be the
52+
bandwidth costs might be applicable. Since bandwidth from GitHub Packages within GitHub Actions is free, I expect
53+
GitHub Container Registry to also be usable for free within GitHub Actions in the future. If that were not to be the
5454
case, I might publish the Docker image to a different platform.</p>
5555
</div>
5656
<div class=navig>

site/public/docs/usage/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<div id=main-container><div id=header>
99
<ul id=navigation>
1010
<li><a href=/about>About</a></li>
11-
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
11+
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
1212
<li><a href=/docs/installation/>Docs</a></li>
1313
<li><a href=/>Home</a></li>
1414
</ul>
@@ -21,7 +21,7 @@ <h2>A fast Kubernetes manifests validator</h2>
2121
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
2222
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
2323
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
24-
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
24+
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
2525
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
2626
</ul>
2727
<div id=main>

site/public/docs/using-as-a-go-module/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<div id=main-container><div id=header>
99
<ul id=navigation>
1010
<li><a href=/about>About</a></li>
11-
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
11+
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
1212
<li><a href=/docs/installation/>Docs</a></li>
1313
<li><a href=/>Home</a></li>
1414
</ul>
@@ -21,12 +21,12 @@ <h2>A fast Kubernetes manifests validator</h2>
2121
<li><a href=http://kubeconform.mandragor.org/docs/usage/>Usage</a></li>
2222
<li><a href=http://kubeconform.mandragor.org/docs/crd-support/>Custom Resources support</a></li>
2323
<li><a href=http://kubeconform.mandragor.org/docs/json-schema-conversion/>OpenAPI to JSON Schema conversion</a></li>
24-
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>Github Action</a></li>
24+
<li><a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/>GitHub Action</a></li>
2525
<li><a href=http://kubeconform.mandragor.org/docs/using-as-a-go-module/>Kubeconform as a Go module</a></li>
2626
</ul>
2727
<div id=main>
2828
<div class=navig>
29-
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>&lt; Github Action</a>
29+
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>&lt; GitHub Action</a>
3030
<a href=# id=prev></a>
3131
</div>
3232
<div id=content-text>
@@ -37,7 +37,7 @@ <h1>Kubeconform as a Go module</h1>
3737
<p>Additional documentation on <a href=https://pkg.go.dev/github.com/yannh/kubeconform/pkg/validator>pkg.go.dev</a></p>
3838
</div>
3939
<div class=navig>
40-
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>&lt; Github Action</a>
40+
<a href=http://kubeconform.mandragor.org/docs/usage-as-github-action/ id=prev>&lt; GitHub Action</a>
4141
<a href=# id=prev></a>
4242
</div>
4343
<script defer src=/js/prism.js></script>

site/public/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<div id=main-container><div id=header>
1010
<ul id=navigation>
1111
<li><a href=/about>About</a></li>
12-
<li><a href=https://github.com/yannh/kubeconform/>Github</a></li>
12+
<li><a href=https://github.com/yannh/kubeconform/>GitHub</a></li>
1313
<li><a href=/docs/installation/>Docs</a></li>
1414
<li><a href=/>Home</a></li>
1515
</ul>

0 commit comments

Comments
 (0)