Skip to content

Commit

Permalink
Merge branch 'main' into chore/2634/disable_keptn_cert_manager_secret…
Browse files Browse the repository at this point in the history
…_check_keptn-cert-manager
  • Loading branch information
geoffrey1330 authored Dec 20, 2023
2 parents 6b346e9 + aa1abf0 commit e330338
Show file tree
Hide file tree
Showing 138 changed files with 2,061 additions and 2,488 deletions.
4 changes: 2 additions & 2 deletions .github/actions/deploy-keptn-on-cluster/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ runs:
using: "composite"
steps:
- name: Set up Go 1.x
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: true
cache-dependency-path: '**/go.sum'
check-latest: true

- name: Download artifacts
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
path: ~/download/artifacts

Expand Down
28 changes: 14 additions & 14 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
(?:^|/)(?i)LICENSE
/package-lock\.json$
/swagger-ui/
CODEOWNERS
CONTRIBUTORS.md
CHANGELOG.md
ignore$
\.editorconfig$
\.gif$
\.gitkeep$
\.ico$
\.jpg$
\.map$
\.mod$
\.npmrc$
\.png$
\.jpg$
\.ttf$
\.sav$
\.sum$
\.xlf$
\.svg$
\.ico$
\.ttf$
\.xlf$
\.zip$
\.gif$
^\.github/actions/spelling
_test\.go$
^examples/support/observability/config/
^examples/support/observability/assets/
^test/prometheus/
^\.github/scripts/\.helm-tests/[a-zA-Z0-9-]+/result.ya?ml
^\Qdocs/layouts/partials/hooks/body-end.html\E$
^dashboards/grafana/configmap/.*\.ya?ml
^dashboards/grafana/import/.*\.json
^\Qdocs/layouts/partials/hooks/body-end.html\E$
^examples/support/observability/assets/
^examples/support/observability/config/
^test/prometheus/
_test\.go$
CHANGELOG.md
CODEOWNERS
CONTRIBUTORS.md
ignore$
34 changes: 12 additions & 22 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ autoprefixer
autoprovision
autoscaler
azurecr
Bacher
bacherfl
badanalysis
badmetric
Expand Down Expand Up @@ -119,9 +120,9 @@ cyclomatic
cytopia
daemonset
dario
databranch
datadog
datasource
datetime
davidanson
dawidd
dco
Expand All @@ -144,7 +145,6 @@ docsembed
docsy
donath
dql
draggable
DTAPI
dtclient
dupl
Expand Down Expand Up @@ -175,7 +175,6 @@ Eventqueue
eventsender
exampleuser
fakeclient
favicons
fetchintervalseconds
fieldpath
fieldref
Expand All @@ -198,6 +197,8 @@ getjson
getopt
gexec
gha
ghrs
ghtoken
ginkgotypes
Gitlab
gke
Expand All @@ -217,9 +218,9 @@ govulncheck
grafana
graphql
groupversion
gstatic
gtag
GVK
haspopup
healthz
hellopy
helloworldtask
Expand All @@ -231,7 +232,6 @@ homeobservability
homeorchestrate
horizontalpodautoscalers
hpa
hreflang
hsla
htmltest
httpref
Expand Down Expand Up @@ -268,8 +268,9 @@ ITarget
itemstatus
ITracer
jaegertracing
javascript
javascripts
jetstack
jgehrcke
Jhb
jsonschema
jwt
Expand Down Expand Up @@ -366,25 +367,20 @@ kustomizeconfig
kuttl
kwi
kwv
labelledby
lastmod
lastword
Lato
lfc
Lifcycle
lifecyclekeptnsh
linecap
linejoin
linkedin
linktitle
linting
listitem
livenessprobe
loadtests
LOCALBIN
logf
logr
lowbound
makefiles
markdownfiles
markdownlint
Expand Down Expand Up @@ -427,7 +423,6 @@ myservice
myuser
myversion
namespacedelete
nbsp
netlify
Neue
nifi
Expand All @@ -438,7 +433,6 @@ nodename
nolint
nonroot
noreply
nowrap
nsa
oac
oauth
Expand Down Expand Up @@ -479,7 +473,6 @@ persistentvolumes
phaseitem
pid
pipefail
placeholders
poc
poddisruptionbudgets
podgroups
Expand Down Expand Up @@ -557,6 +550,7 @@ serrors
serviceaccount
serviceaccountspec
serviceport
setuptools
shellcheck
SHELLFLAGS
shortcode
Expand All @@ -575,16 +569,15 @@ spanitem
spdx
spf
squidfunk
sre
stakeholders
standalone
statefulset
statefultest
stdouttrace
storageclasses
storageversion
striptags
sts
stylesheet
subchart
subdir
subjectaccessreviews
Expand Down Expand Up @@ -620,13 +613,10 @@ timeseries
timespan
timezone
tmp
tmpl
toc
tocstop
tokenreviews
toml
totalscore
tpl
tplvalues
traceparent
tracerfactory
Expand All @@ -641,8 +631,8 @@ undeploy
unmarshal
unmarshalling
urlset
usecase
usecasebox
usecases
usr
utilruntime
validatingwebhookconfigurations
Expand All @@ -652,6 +642,7 @@ vcluster
Vec
versioned
versioning
virtualenv
visualise
visualised
vkeptnmetric
Expand All @@ -666,6 +657,7 @@ webhooknamespaces
website
whitespaces
whykeptn
Wiesinger
wjdp
wli
Wls
Expand All @@ -677,12 +669,10 @@ WORKLOADOVERALLSTATUS
workloadsstate
workloadstatus
workloadversion
xhtml
xxxx
XXXXXXXXXXXXXXXXXXXXXXXX
yannh
yml
YOURNAME
yourregistry
youtube
squidfunk
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ render:
knownTypes:
- name: ResourceReference
package: github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha3
link: ../v1alpha3/#resourcereference
link: ../v1alpha3/index.md#resourcereference
- name: ItemStatus
package: github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha3
link: ../v1alpha3/#itemstatus
link: ../v1alpha3/index.md#itemstatus
- name: Quantity
package: "k8s.io/apimachinery/pkg/api/resource"
link: https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity
Expand Down
28 changes: 17 additions & 11 deletions .github/scripts/generate-crd-docs/generate-crd-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ RENDERER='markdown'
RENDERER_CONFIG_FILE_TEMPLATE_PATH='.github/scripts/generate-crd-docs/crd-docs-generator-config'
RENDERER_CONFIG_FILE=$RENDERER_CONFIG_FILE_TEMPLATE_PATH'.yaml'
PATH=$PATH:$(go env GOPATH)/bin
DOCS_PATH=./docs/content/en/docs/reference/api-reference/
DOCS_PATH=./docs-new/docs/reference/api-reference/

echo "Checking if code generator tool is installed..."
if ! test -s crd-ref-docs; then
Expand All @@ -32,14 +32,15 @@ echo "Running CRD docs auto-generator..."
for api_group in "$OPERATOR_API_ROOT"*; do

sanitized_api_group="${api_group#$OPERATOR_API_ROOT}"
INDEX_PATH="$DOCS_PATH$sanitized_api_group/_index.md"
INDEX_PATH="$DOCS_PATH$sanitized_api_group"

if [ ! -f "$INDEX_PATH" ]; then
if [ ! -f "$INDEX_PATH/index.md" ]; then
echo "API group index file doesn't exist for group $sanitized_api_group. Creating it now..."
# Use sanitized_api_group and make first char uppercase
API_GROUP="$(tr '[:lower:]' '[:upper:]' <<< "${sanitized_api_group:0:1}")${sanitized_api_group:1}"
export API_GROUP
envsubst < './.github/scripts/generate-crd-docs/templates/index-template.md' > "$INDEX_PATH"
mkdir -p "$INDEX_PATH"
envsubst < './.github/scripts/generate-crd-docs/templates/index-template.md' > "$INDEX_PATH/index.md"
unset API_GROUP
fi
for api_version in "$api_group"/*; do
Expand All @@ -49,17 +50,21 @@ for api_group in "$OPERATOR_API_ROOT"*; do

renderer_config_file="$RENDERER_CONFIG_FILE_TEMPLATE_PATH-$sanitized_api_group-$sanitized_api_version.yaml"
if [ ! -f "$renderer_config_file" ]; then
echo "Using default configuration..."
renderer_config_file=$RENDERER_CONFIG_FILE
else
echo "Using API version specific configuration..."
fi


echo "Arguments:"
echo "TEMPLATE_DIR: $TEMPLATE_DIR"
echo "OPERATOR_API_ROOT: $OPERATOR_API_ROOT"
echo "API_GROUP: $sanitized_api_group"
echo "API_VERSION: $sanitized_api_version"
echo "RENDERER: $RENDERER"
echo "RENDERER_CONFIG_FILE: $renderer_config_file"
echo "OUTPUT_PATH: $OUTPUT_PATH/_index.md"
echo "OUTPUT_PATH: $OUTPUT_PATH/index.md"

echo "Creating docs folder $OUTPUT_PATH..."
mkdir -p "$OUTPUT_PATH"
Expand All @@ -72,7 +77,7 @@ for api_group in "$OPERATOR_API_ROOT"*; do
--renderer="$RENDERER" \
--config "$renderer_config_file" \
--max-depth 15 \
--output-path "$OUTPUT_PATH/_index.md"
--output-path "$OUTPUT_PATH/index.md"
echo "---------------------"
done
done
Expand All @@ -81,14 +86,15 @@ done


sanitized_api_group="metrics"
INDEX_PATH="$DOCS_PATH$sanitized_api_group/_index.md"
INDEX_PATH="$DOCS_PATH$sanitized_api_group"

if [ ! -f "$INDEX_PATH" ]; then
if [ ! -f "$INDEX_PATH/index.md" ]; then
echo "API group index file doesn't exist for group $sanitized_api_group. Creating it now..."
# Use sanitized_api_group and make first char uppercase
API_GROUP="$(tr '[:lower:]' '[:upper:]' <<< "${sanitized_api_group:0:1}")${sanitized_api_group:1}"
export API_GROUP
envsubst < './.github/scripts/generate-crd-docs/templates/index-template.md' > "$INDEX_PATH"
mkdir -p "$INDEX_PATH"
envsubst < './.github/scripts/generate-crd-docs/templates/index-template.md' > "$INDEX_PATH/index.md"
unset API_GROUP
fi

Expand All @@ -103,7 +109,7 @@ for api_version in "$METRICS_API_ROOT"*; do
echo "API_VERSION: $sanitized_api_version"
echo "RENDERER: $RENDERER"
echo "RENDERER_CONFIG_FILE: $RENDERER_CONFIG_FILE"
echo "OUTPUT_PATH: $OUTPUT_PATH/_index.md"
echo "OUTPUT_PATH: $OUTPUT_PATH/index.md"

echo "Creating docs folder $OUTPUT_PATH..."
mkdir -p "$OUTPUT_PATH"
Expand All @@ -116,6 +122,6 @@ for api_version in "$METRICS_API_ROOT"*; do
--renderer="$RENDERER" \
--config "$RENDERER_CONFIG_FILE" \
--max-depth 15 \
--output-path "$OUTPUT_PATH/_index.md"
--output-path "$OUTPUT_PATH/index.md"
echo "---------------------"
done
8 changes: 4 additions & 4 deletions .github/scripts/generate-crd-docs/templates/gv_list.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
{{- $groupVersions := . -}}
{{- $groupVersion := index $groupVersions 0 -}}

---
title: {{ $groupVersion.Version }}
description: Reference information for {{ $groupVersion.GroupVersionString }}
---
# {{ $groupVersion.Version }}

Reference information for {{ $groupVersion.GroupVersionString }}

<!-- markdownlint-disable -->

## Packages
Expand Down
7 changes: 3 additions & 4 deletions .github/scripts/generate-crd-docs/templates/index-template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
title: $API_GROUP API
description: Reference information about the $API_GROUP API
---
# $API_GROUP API

Reference information about the $API_GROUP API.
Loading

0 comments on commit e330338

Please sign in to comment.