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

Add sonar documentation #2639

Merged
merged 3 commits into from
Jul 17, 2022
Merged

Conversation

antarus
Copy link
Contributor

@antarus antarus commented Jul 17, 2022

close #2543

@antarus antarus marked this pull request as ready for review July 17, 2022 15:40
@pascalgrimaud pascalgrimaud added area: documentation 📚 Improvements or additions to documentation theme: init labels Jul 17, 2022
@antarus
Copy link
Contributor Author

antarus commented Jul 17, 2022

@pascalgrimaud test add

@codecov
Copy link

codecov bot commented Jul 17, 2022

Codecov Report

Merging #2639 (9883e9e) into main (fe1c95a) will not change coverage.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##                main     #2639   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
+ Complexity      2292      2262   -30     
===========================================
  Files            542       539    -3     
  Lines           9280      9189   -91     
  Branches         231       230    -1     
===========================================
- Hits            9280      9189   -91     
Impacted Files Coverage Δ
...rator/server/sonar/domain/SonarModulesFactory.java 100.00% <100.00%> (ø)
...ent/react/core/domain/ReactCoreModulesFactory.java 100.00% <0.00%> (ø)
.../core/application/ReactCoreApplicationService.java 100.00% <0.00%> (ø)
...t/common/domain/SpringBootCommonDomainService.java 100.00% <0.00%> (ø)
...ation/liquibase/domain/LiquibaseDomainService.java 100.00% <0.00%> (ø)
...ructure/primary/ReactCodeModulesConfiguration.java 100.00% <0.00%> (ø)
...h/application/AngularHealthApplicationService.java 100.00% <0.00%> (ø)
...pplication/SpringBootCommonApplicationService.java 100.00% <0.00%> (ø)
...mongock/application/MongockApplicationService.java 100.00% <0.00%> (ø)
...ibase/application/LiquibaseApplicationService.java 100.00% <0.00%> (ø)
... and 24 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fe1c95a...9883e9e. Read the comment docs.

@DamnClin
Copy link
Collaborator

I think we should add short readmesection for the docker image (I made a test in the mongo DB module)

@antarus
Copy link
Contributor Author

antarus commented Jul 17, 2022

ok I'll look it up

@antarus
Copy link
Contributor Author

antarus commented Jul 17, 2022

@DamnClin
Isn't it a little redundant to have the documentation and after the docker-compose to launch?

maybe add a specific needle to the docker to start before documentation ?

@DamnClin
Copy link
Collaborator

I don't know, most of the time I have many docker to start (and I make a makefile but that's not the subject...), I'dd like to have all the command in the frontpage

@antarus
Copy link
Contributor Author

antarus commented Jul 17, 2022

I agree with you, I regularly make a script to start everything but if you want to put all the useful commands at launch, they would be better under npm install in the readme, wouldn't they?

@DamnClin
Copy link
Collaborator

Totally, good idea

@antarus
Copy link
Contributor Author

antarus commented Jul 17, 2022

which name would be the most appropriate for this needle ? i can do a MR

@DamnClin
Copy link
Collaborator

sounds good. I think we should also add a shortcut in JHipsterModule where you give the command and it's doing the other part (formatting, replacement, etc)

@pascalgrimaud pascalgrimaud merged commit b291c4a into jhipster:main Jul 17, 2022
@pascalgrimaud
Copy link
Member

I don't know, most of the time I have many docker to start (and I make a makefile but that's not the subject...), I'dd like to have all the command in the frontpage

For your information, in generator-jhipster: there are some npm commands to start all docker-compose services. See https://github.com/jhipster/jhipster-sample-app/blob/main/package.json#L32-L38

Some users said me they don't like this, as it looks strange to have these kinds of commands inside package.json
So here some suggestions, in JHipster Lite:

  • a module which add to package.json these kind of commands, using docker-compose
  • a module which will init a makefile and add the different commands

If you think it's a good idea, we can open a ticket for that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📚 Improvements or additions to documentation theme: init
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation in sonar module
3 participants