Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quarkiverse extension template improvements #22034

Closed
gsmet opened this issue Dec 8, 2021 · 2 comments · Fixed by #26174
Closed

Quarkiverse extension template improvements #22034

gsmet opened this issue Dec 8, 2021 · 2 comments · Fixed by #26174
Assignees
Labels
area/quarkiverse This issue/PR is part of the Quarkiverse organization kind/enhancement New feature or request
Milestone

Comments

@gsmet
Copy link
Member

gsmet commented Dec 8, 2021

Description

General

  • When I created JGit, it somehow was replaced by Jgit (no capital G) in the extension name and several other places. I'm pretty sure I did it right and I think I had the same issue with JSch.
  • I think it would probably be nice to have the src/main/(java|resources) src/test/(java|resources) created for both runtime and deployment. From what I saw, some are missing.

Runtime

  • Maybe we should have a <description>Put a description here</description> in the runtime template? Not worse than having the Quarkiverse parent description appearing IMHO. But I wonder if we should make a description field mandatory when creating an extension. It could then be wired automatically. We need one anyway so why not make it mandatory?
  • Maybe we should point to the Quarkiverse doc by default and have a guide entry?

Docs

https://github.com/quarkiverse/quarkus-neo4j/ is a good example for that

  • docs should have a proper pom.xml, see the template for the new extension I created
    • pom also handles the copy of the potential generated config file to the right place, we probably won't get it right always given it depends on the config root but we could try using the extension name as an approximation
  • docs/templates directory should be included
    • the Maven version replaced with what we have in the build)
    • the :quarkus-neo4j-version: would probably be better with a :project-version: to be more generic and avoid having to update it
  • docs/modules/ROOT/assets/images should be included as it's not easy to figure out how to make images work
  • in docs/antora.yml , title should be Quarkus Extension and not Quarkus - Extension (no dash). The idea is that we don't want to convey the idea it's part of Quarkus (also it messes up the order in Antora)
  • docs/modules/ROOT/pages/config.adoc containing Freemarker config should go away
  • index.adoc should be updated to:
    • use the attributes.adoc we generate (see Neo4j for example)
    • use the generated config include file we generate (and copy with the pom) - maybe with an optional by default so that user can build things

CI

  • Release workflow should be updated to take into account the updated file (see neo4j one for instance) - the block Maven Release needs the additional commit and the new block to adjust the tag needs to be in
  • Quarkus snapshot workflow should be updated to point to quarkiverse-extension not quarkus-extension as the ecosystem path
  • Add -Dnative in .github/workflows/build.yml - at least I did it for all the moved extensions as I wanted them to be covered

Implementation ideas

No response

@gsmet gsmet added the kind/enhancement New feature or request label Dec 8, 2021
@quarkus-bot quarkus-bot bot added the kind/extension-proposal Discuss and Propose new extensions label Dec 8, 2021
@quarkus-bot
Copy link

quarkus-bot bot commented Dec 8, 2021

/cc @aloubyansky, @gastaldi, @maxandersen

@gastaldi gastaldi added area/quarkiverse This issue/PR is part of the Quarkiverse organization and removed kind/extension-proposal Discuss and Propose new extensions labels Dec 8, 2021
@maxandersen
Copy link
Contributor

"Maybe we should have a Put a description here in the runtime template? Not worse than having the Quarkiverse parent description appearing IMHO. But I wonder if we should make a description field mandatory when creating an extension. It could then be wired automatically. We need one anyway so why not make it mandatory?"

I would suggest <description>jsch extension for Quarkus<description> as a decent default.

@gsmet gsmet self-assigned this Jun 15, 2022
@quarkus-bot quarkus-bot bot added this to the 2.11 - main milestone Jun 20, 2022
@gsmet gsmet modified the milestones: 2.11 - main, 2.10.1.Final Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/quarkiverse This issue/PR is part of the Quarkiverse organization kind/enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants