Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: review keptntaskdefinition examples #3085

Merged
merged 60 commits into from
Feb 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
6879bf8
docs: review keptntaskdefinition examples
RealAnna Feb 20, 2024
e1fd7d9
fix: wrong url
RealAnna Feb 23, 2024
a817b07
fix: wrong url
RealAnna Feb 23, 2024
f2a6dfd
fix: context ref in task
RealAnna Feb 23, 2024
2c86a81
fix: review link to examples
RealAnna Feb 23, 2024
edb6d1e
fix: remove a httpref
RealAnna Feb 23, 2024
0c01d64
fix: lint
RealAnna Feb 23, 2024
a42e52b
fix: remove disable markdown
RealAnna Feb 23, 2024
3ff4138
fix: remove disable markdown
RealAnna Feb 23, 2024
7932bf5
fix: disable markdown
RealAnna Feb 23, 2024
1207c63
fix: disable markdown
RealAnna Feb 23, 2024
f9f8010
fix: add comment on custom runtime
RealAnna Feb 23, 2024
1b98c51
fix: add comment on custom runtime
RealAnna Feb 23, 2024
3c14c5b
fix: add comment on custom runtime
RealAnna Feb 23, 2024
e650ae3
fix: add comment on custom runtime
RealAnna Feb 23, 2024
df11b17
fix: add note
RealAnna Feb 23, 2024
e20a535
fix: ???+
RealAnna Feb 23, 2024
2c57821
fix: ???+
RealAnna Feb 23, 2024
778dbbb
fix: ???+ all examples
RealAnna Feb 23, 2024
56ce3e0
fix: ???+ all examples
RealAnna Feb 23, 2024
9a2ff29
fix: remove spaces for includes
RealAnna Feb 23, 2024
da17f53
fix: remove spaces for includes
RealAnna Feb 23, 2024
f011f26
fix: nested note
RealAnna Feb 23, 2024
58a4820
fix: nested note no title
RealAnna Feb 23, 2024
8e01b97
fix: linclude raw yaml not github page
RealAnna Feb 23, 2024
11be7e8
fix: linclude raw yaml not github page
RealAnna Feb 23, 2024
f19c693
fix: !!!
RealAnna Feb 23, 2024
2996cc6
fix: refactor examples
RealAnna Feb 23, 2024
58f0373
fix: refactor examples
RealAnna Feb 23, 2024
09c0565
fix: refactor examples
RealAnna Feb 23, 2024
f8aa19b
fix: lint
RealAnna Feb 23, 2024
6536c18
fix: lint
RealAnna Feb 23, 2024
f42b652
fix: all examples
RealAnna Feb 23, 2024
d9fa5a5
fix: all examples
RealAnna Feb 23, 2024
d02c07b
fix: all examples
RealAnna Feb 23, 2024
4c523e1
fix: all links
RealAnna Feb 23, 2024
7ad1ec7
fix: all links
RealAnna Feb 23, 2024
4e197f6
fix: all links
RealAnna Feb 23, 2024
317fdbc
fix: all links
RealAnna Feb 23, 2024
5911e17
fix: all links
RealAnna Feb 23, 2024
4f11da7
fix: typo
RealAnna Feb 23, 2024
fed6be6
fix: typo
RealAnna Feb 23, 2024
e044b3f
fix: typo
RealAnna Feb 23, 2024
e7d6210
fix: typo
RealAnna Feb 23, 2024
f3b3145
fix: typo
RealAnna Feb 23, 2024
6e51811
fix: typo
RealAnna Feb 23, 2024
14ccbe1
fix: typo
RealAnna Feb 23, 2024
529eba7
fix: typo
RealAnna Feb 23, 2024
c6d36cc
fix: typo
RealAnna Feb 23, 2024
27fa4bb
fix: typo
RealAnna Feb 23, 2024
66117a8
fix: typo
RealAnna Feb 23, 2024
8956537
fix: typo
RealAnna Feb 23, 2024
b41cfa7
fix: typo
RealAnna Feb 23, 2024
7feadc8
fix: typo
RealAnna Feb 23, 2024
1a1ea40
fix: typo
RealAnna Feb 23, 2024
fcb2bad
fix: typo
RealAnna Feb 23, 2024
d731db4
fix: typo
RealAnna Feb 23, 2024
cfae51c
fix: typo
RealAnna Feb 23, 2024
ccf6f4a
fix: typo
RealAnna Feb 26, 2024
026281b
fix: typo
RealAnna Feb 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,6 @@ moq
mowies
mpod
multigroup
multipe
mutatingwebhookconfigurations
mwc
mwh
Expand Down
1 change: 0 additions & 1 deletion .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ config:
allowed_elements:
- details
- summary
- a
github-admonition: true
max-one-sentence-per-line: true

Expand Down
29 changes: 29 additions & 0 deletions docs/docs/assets/crd/deno-context.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
apiVersion: v1
kind: Secret
metadata:
name: mysecret
type: Opaque
data:
SECURE_DATA: dG9rZW46IG15dG9rZW4=
---
apiVersion: lifecycle.keptn.sh/v1beta1
kind: KeptnTaskDefinition
metadata:
name: pre-deployment-hello
annotations: ## accessible via "KEPTN_CONTEXT"
my: test
spec:
deno:
parameters: ## accessible via "DATA"
map:
user: "myuser"
secureParameters: ## accessible via "SECURE_DATA"
secret: mysecret
inline:
code: |
const data = Deno.env.get("DATA")!;
const secret = Deno.env.get("SECURE_DATA")!;
const context = Deno.env.get("KEPTN_CONTEXT")!;
console.log(data);
console.log(secret);
console.log(context);
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kind: KeptnTaskDefinition
metadata:
name: scheduled-deployment
spec:
function:
deno:
configMapRef:
name: scheduled-deployment-cm-1
---
Expand Down

This file was deleted.

11 changes: 9 additions & 2 deletions docs/docs/guides/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,8 +243,15 @@ your workloads and tasks in a `KeptnApp` (for instance a commit ID value).
To do so, the metadata needs to be specified for the workload or for the application.
Follow our guide on [Context and Metadata here](./metadata.md).

For an example of how to access the `KEPTN_CONTEXT`, follow our
[reference page](../reference/crd-reference/taskdefinition.md#example-6-accessing-keptn_context-environment-variable-in-a-deno-task)
<!-- markdownlint-disable MD046 max-one-sentence-per-line-->

!!! note

For an example of how to access the `KEPTN_CONTEXT`, follow our reference page examples
[for deno](../reference/crd-reference/taskdefinition.md#accessing-keptn_context-in-a-deno-task)
and [for python](../reference/crd-reference/taskdefinition.md#accessing-keptn_context-in-a-python-task).

<!-- markdownlint-enable MD046 max-one-sentence-per-line-->

## Parameterized functions

Expand Down
Loading
Loading