apache/airflow

Publish JSON schema for airflow.cfg

Open

#42.850 aberto em 9 de out. de 2024

Ver no GitHub
 (16 comments) (0 reactions) (0 assignees)Python (16.781 forks)batch import
area:dev-envgood first issuekind:feature

Métricas do repositório

Stars
 (44.809 stars)
Métricas de merge de PR
 (Mesclagem média 7d 18h) (834 fundiu PRs em 30d)

Description

Description

There is already a good structured YAML file providing metadata about all valid configuration options in airflow.cfg: airflow/config_templates/config.yml.

I think publishing the same data as a JSON schema and eventually to https://www.schemastore.org/json/ could be very useful.

Use case/motivation

  • People could use extensions like Even Better TOML with their IDE to benefit from validation and powerful auto-completion while editing airflow.cfg
  • It would be easy to leverage pre-commit hooks or other CI tools to catch mistakes in the config file.

Airflow won't complain if the configuration file contains a typo or a non-existent configuration key making it easy to make mistakes. It could also make it easier to catch invalid values earlier.

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Guia do colaborador

Direção de pesquisa
Comece examinando o arquivo YAML existente em airflow/config templates/config.yml. Considere usar um script Python com bibliotecas como `json schema generator` ou `pyyaml` para converter a estrutura YAML em um esquema JSON. Em seguida, publique o esquema em https://www.schemastore.org/json/. Verifique os comentários da issue para quaisquer requisitos específicos sobre geração ou formato do esquema.
Pilha de tecnologia
python
Domain
developer experiencetooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonJSON SchemaYAML
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70