You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/05/13 18:54:10 UTC
[GitHub] [airflow] jedcunningham opened a new pull request #15827: Build chart parameter docs from `values.schema.json`
jedcunningham opened a new pull request #15827:
URL: https://github.com/apache/airflow/pull/15827
This automatically builds the chart parameter docs page from the
`values.schema.json`. It also tracks and enforces that the defaults in
`values.yaml` and `values.schema.json` match.
The parameter docs page now has different sections, which are set in the
schema file under `docs_schema`. That key is required for top level
properties in the schema file, and optional otherwise as the parents
`docs_schema` is used as a default.
We also now have a schema for our `values.schema.json` in
`values_schema.schema.json` which enforces the items we need to build
the docs are set appropriately: `docs_schema`, `default`, and
`description`.
Closes #15771
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] mik-laj commented on a change in pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #15827:
URL: https://github.com/apache/airflow/pull/15827#discussion_r632075722
##########
File path: chart/values.yaml
##########
@@ -1007,6 +1007,7 @@ dags:
# interval between git sync attempts in seconds
wait: 60
containerName: git-sync
+ # TODO: Should this be 65534?
uid: 65533
Review comment:
Itt should be able 65533. See: https://github.com/kubernetes/git-sync/blob/b0ac361b2cf1a1c278bfd5e0cd0368131ddabd30/Dockerfile.in#L62
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil merged pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
kaxil merged pull request #15827:
URL: https://github.com/apache/airflow/pull/15827
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #15827:
URL: https://github.com/apache/airflow/pull/15827#discussion_r632100268
##########
File path: chart/values.schema.json
##########
@@ -2,68 +2,112 @@
"$schema": "http://json-schema.org/draft-07/schema",
"description": "Default values for airflow. Declare variables to be passed into your templates.",
"type": "object",
+ "docs_section_order": [
Review comment:
Let's do it in the follow-up PR please
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #15827:
URL: https://github.com/apache/airflow/pull/15827#issuecomment-840778188
[The Workflow run](https://github.com/apache/airflow/actions/runs/839902683) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] mik-laj commented on a change in pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #15827:
URL: https://github.com/apache/airflow/pull/15827#discussion_r632079638
##########
File path: chart/values.schema.json
##########
@@ -2,68 +2,112 @@
"$schema": "http://json-schema.org/draft-07/schema",
"description": "Default values for airflow. Declare variables to be passed into your templates.",
"type": "object",
+ "docs_section_order": [
Review comment:
What do you think to use the `x-` prefix to denote that this field is not part of the official JSON Schema specification? This is not required in our case, but I think it will improve readability.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #15827:
URL: https://github.com/apache/airflow/pull/15827#discussion_r632099865
##########
File path: chart/values.yaml
##########
@@ -1007,6 +1007,7 @@ dags:
# interval between git sync attempts in seconds
wait: 60
containerName: git-sync
+ # TODO: Should this be 65534?
Review comment:
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #15827:
URL: https://github.com/apache/airflow/pull/15827#discussion_r632107392
##########
File path: chart/values.schema.json
##########
@@ -2,68 +2,112 @@
"$schema": "http://json-schema.org/draft-07/schema",
"description": "Default values for airflow. Declare variables to be passed into your templates.",
"type": "object",
+ "docs_section_order": [
Review comment:
#15828
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #15827:
URL: https://github.com/apache/airflow/pull/15827#discussion_r632089020
##########
File path: chart/values.schema.json
##########
@@ -2,68 +2,112 @@
"$schema": "http://json-schema.org/draft-07/schema",
"description": "Default values for airflow. Declare variables to be passed into your templates.",
"type": "object",
+ "docs_section_order": [
Review comment:
I'm okay with that. Maybe `x-docsSectionOrder` and `x-docsSection`? Feels like we should use the `x-` prefix everywhere for non standard fields?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #15827: Build chart parameter docs from `values.schema.json`
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #15827:
URL: https://github.com/apache/airflow/pull/15827#issuecomment-840778560
[The Workflow run](https://github.com/apache/airflow/actions/runs/839921725) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org