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

Improve header in README.md based on name and description #29827

Merged
merged 1 commit into from Dec 21, 2022

Conversation

gsmet
Copy link
Member

@gsmet gsmet commented Dec 13, 2022

And also allows to not include the default content with a particular extension.

@ia3andy I did two changes here:

  • now that we have the name and the description of the project, we can use them in the README.md
  • I also included a boolean to be able to disable the default content. I agree that it's only to be used in very specific cases but I don't think it hurts as it's pretty straightforward

I think that there are extensions that really redefines what the project is about such as my Quarkus GitHub Action thing, but also lambdas where we will probably want a completely different content in the README.

Maybe we could think about allowing that more cleanly but in the meantime having this simple hack would help (in my case, I don't expect any additional extensions providing content to the README so it works pretty much OK).

If you really feel strongly about the second change, I can go back to just the first one.

Keeping as draft until I have your opinion.

And also allows to not include the default content with a particular
extension.
@gsmet gsmet requested a review from ia3andy December 13, 2022 13:04
@quarkus-bot quarkus-bot bot added area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/platform Issues related to definition and interaction with Quarkus Platform labels Dec 13, 2022
@ia3andy
Copy link
Contributor

ia3andy commented Dec 13, 2022

That seems like a smart move 👍

@ia3andy
Copy link
Contributor

ia3andy commented Dec 13, 2022

Just we need to make sure no extension codestart is setting it to true :) (it would behave inconsistently and randomly)

@gsmet
Copy link
Member Author

gsmet commented Dec 13, 2022

Yeah, I would lean towards keeping it a hidden 'feature' and not invest much more time on it except if we have complaints.

@gsmet gsmet marked this pull request as ready for review December 20, 2022 13:32
@gsmet
Copy link
Member Author

gsmet commented Dec 20, 2022

@ia3andy this is now ready for review!

Copy link
Contributor

@ia3andy ia3andy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool!

@quarkus-bot
Copy link

quarkus-bot bot commented Dec 20, 2022

Failing Jobs - Building b44cc34

Status Name Step Failures Logs Raw logs
✔️ JVM Tests - JDK 11
✔️ JVM Tests - JDK 17
JVM Tests - JDK 17 MacOS M1 Set up runner ⚠️ Check → Logs Raw logs
✔️ JVM Tests - JDK 18
Native Tests - Security1 Build ⚠️ Check → Logs Raw logs

@gsmet gsmet merged commit 0193983 into quarkusio:main Dec 21, 2022
@quarkus-bot quarkus-bot bot added this to the 2.16 - main milestone Dec 21, 2022
@gsmet gsmet modified the milestones: 2.16 - main, 2.15.1.Final Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/platform Issues related to definition and interaction with Quarkus Platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants