quarkiverse / quarkus-github-action

Develop your GitHub Actions in Java with Quarkus.
https://docs.quarkiverse.io/quarkus-github-action/dev/index.html
Apache License 2.0
20 stars 7 forks source link

codestart fails when creating project and breaks code.quarkus.io #188

Open maxandersen opened 12 months ago

maxandersen commented 12 months ago
quarkus create app -x github-action xyzdkdk
-----------
selected extensions:
- io.quarkiverse.githubaction:quarkus-github-action

[ERROR] ❗  Unable to create project: Error while rendering template: /codestarts/quarkus/quarkiverse-github-action-codestart/base/action.docker.tpl.qute.yml

which is cause of https://github.com/quarkusio/code.quarkus.io/issues/1231

gsmet commented 12 months ago

Hmmm. This is weird, there was an issue at some point but I thought it was fixed.

gsmet commented 12 months ago

Ah no, so actually, that's expected.

Because you need to push some additional data: https://docs.quarkiverse.io/quarkus-github-action/dev/create-github-action.html#_initialize_your_quarkus_application .

It's mandatory because your project won't work that fine if you don't do that. We could do without the name and use the artifactId, description is optional but in any case you would need to provide the repository you're publishing it to.

Now maybe the GitHub repo could be obtained when we actually push the project to a GH repo (@ia3andy explained me that in this case, we were enabling a specific codestart so we might have the GH repository name handy?)

@ia3andy WDYT?

Maybe we should remove this extension from code.quarkus.io for the time being.

maxandersen commented 12 months ago

okey, but codestarts also shouldn't really require setup as then they are not possible to use from code.quarkus, cli or IDE.

removing it from code quarkus means its hidden -would a non-optimal but better compromise not be to have a default value for that property? "replace/me" or similar with note in the generated readme?

ia3andy commented 12 months ago

okey, but codestarts also shouldn't really require setup as then they are not possible to use from code.quarkus, cli or IDE.

removing it from code quarkus means its hidden -would a non-optimal but better compromise not be to have a default value for that property? "replace/me" or similar with note in the generated readme?

We only have the Github name if it's pushed to GH from code.quarkus.io, but this is an edge case, so better do what Max is suggesting.

gsmet commented 12 months ago

okey, but codestarts also shouldn't really require setup as then they are not possible to use from code.quarkus, cli or IDE.

You can push additional information to the CLI, that's what is in my doc.

removing it from code quarkus means its hidden -would a non-optimal but better compromise not be to have a default value for that property? "replace/me" or similar with note in the generated readme?

Well, it will be the difference between you have everything properly set up and you have to understand how it works.

Using the CLI instructions in my doc, your GitHub Action is ready to go, you push it on GitHub and it works out of the box.

We only have the Github name if it's pushed to GH from code.quarkus.io, but this is an edge case, so better do what Max is suggesting.

In the case of a GitHub Action project, I think it's not that a bad experience. In any case, it should be something we handle. Do you know how I can get the repository information? Do we extract the org/repository?