crossplane / crossplane/function-template-python

missing Post-initialization hooks for init commands

Aberta
#88 1 comentário 1 reação 0 responsáveis Ver no GitHub
enhancement good first issue help wanted
Linguagem predominante
Python
Estrelas
21
Forks
13
Merge médio
3h 1min
PRs com merge (30d)
1

Descrição

### What problem are you facing?
as per the docs: https://docs.crossplane.io/latest/guides/write-a-composition-function-in-python/
and the tip, which I quote:
> In v1.14 of the Crossplane CLI crossplane xpkg init just clones a template GitHub repository. A future CLI release will automate tasks like replacing the template name with the new function’s name. See Crossplane issue [#4941](https://github.com/crossplane/crossplane/issues/4941) for details.

It would be ideal if this repo would provide scaffolding mechanism so that developers don't need to manually change parameters (package’s name is one) after the templated repo has been cloned.

Alternatively if this has been fixed already I guess the tip need to be removed from the docs and it should work via cli as I am using
```
ζ crossplane version
Client Version: v1.17.1
Server Version: v1.17.1-up.1
```
and it doesn't work when creating a new function command:
```
ζ crossplane xpkg init function-pop https://github.com/crossplane/function-template-python -d function-pop
Initialized package "function-pop" in directory "/Users/huh/Documents/sandbox/crossplane/function-pop" from https://github.com/crossplane/function-template-python/tree/88ae9b958787096fc72415217807ad4cf6515ec6 (main)
ζ cat function-pop/package/crossplane.yaml
---
apiVersion: meta.pkg.crossplane.io/v1beta1
kind: Function
metadata:
name: function-template-python
spec: {}
```

### How could this ~Function~ help solve your problem?
To improve developer experience and eventually prevent people from falling in a rabbit hole as the documentation link points at an issue that has been seemingly been solved but no clear resolution can be deducted from that

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Comece revisando o guia vinculado de Python composition-function e reproduzindo o comando crossplane xpkg init documentado. Inspecione o package/crossplane.yaml gerado e determine o comportamento pretendido após a inicialização com base na issue e na Crossplane issue #4941. Está concluído quando a inicialização não deixar mais o nome do pacote do template inalterado ou quando a documentação refletir claramente o comportamento compatível.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
cli, developer-experience, tooling
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.