missing Post-initialization hooks for init commands
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- cli, developer-experience, tooling
Research direction
Start by reviewing the linked Python composition-function guide and reproducing the documented crossplane xpkg init command. Inspect the generated package/crossplane.yaml and determine the intended post-initialization behavior from the issue and Crossplane issue #4941. Done means initialization no longer leaves the template package name unchanged, or the documentation clearly reflects the supported behavior.
Written by the indexing model from the issue text.
Description
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 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
- Dominant language
- Python
- Stars
- 21
- Forks
- 13
- Avg merge
- 3h 1m
- Merged PRs (30d)
- 1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from crossplane/function-template-python
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Dependency Dashboard Open
Difficulty 1/5 Under an hour Newbie friendliness 10/100
All issues in crossplane/function-template-python
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100