-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
remove -it flag, add --rm flag also in ci, bring back pull step
and explain why the pull step is necessary also remove trailing whitespaces
- Loading branch information
1 parent
832b6a6
commit da503ec
Showing
2 changed files
with
44 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,29 @@ | ||
![](https://jb.gg/badges/official-flat-square.svg) | ||
![](resources/eap-alert.png) | ||
![](resources/eap-alert.png) | ||
![](resources/banner-main.png) | ||
|
||
**Qodana** is a code quality monitoring tool that identifies and suggests fixes for bugs, security vulnerabilities, duplications, and imperfections. | ||
It brings all the smart features you love in the JetBrains IDEs into your project pipelines. | ||
**Qodana** is a code quality monitoring tool that identifies and suggests fixes for bugs, security vulnerabilities, duplications, and imperfections. | ||
It brings all the smart features you love in the JetBrains IDEs into your project pipelines. | ||
It takes different shapes: [Docker for any CI](Docker/README.md), [GitHub actions & application](GitHub/README.md), a [TeamCity plugin](TeamCity/README.md), and a separate [cloud service](Service/README.md). They all share a common goal: guiding users towards more robust, more maintainable, and healthier code. | ||
|
||
Qodana already supports PHP, Java, and Kotlin projects, and will eventually support all [languages and technologies](General/supported-technologies.md) covered by JetBrains IDEs. | ||
|
||
### Analyse project locally | ||
|
||
To start, pull the image from Docker Hub: | ||
To start, pull the image from Docker Hub (only necessary to get the latest version): | ||
``` | ||
docker pull jetbrains/qodana | ||
``` | ||
|
||
and run the analysis locally: | ||
``` | ||
docker run -v <source-directory>/:/data/project/ -p 8080:8080 jetbrains/qodana --show-report | ||
docker run --rm -v <source-directory>/:/data/project/ -p 8080:8080 jetbrains/qodana --show-report | ||
``` | ||
|
||
where `source-directory` should point to the root of your project. | ||
|
||
Check the results in your browser at [`http://localhost:8080`](http://localhost:8080). | ||
|
||
Please read our [Docker guide](/Docker/README.md) for more options and details related to the Qodana execution. | ||
|
||
### Run at GitHub | ||
|
@@ -36,4 +36,4 @@ By using Qodana, you agree to the [JetBrains EAP user agreement](https://www.jet | |
|
||
## Contact | ||
|
||
Contact us at [[email protected]](mailto:[email protected]) or via [our issue tracker](https://youtrack.jetbrains.com/newIssue?project=QD). We are eager to receive your feedback on the existing Qodana functionality and learn what other features you miss in it. | ||
Contact us at [[email protected]](mailto:[email protected]) or via [our issue tracker](https://youtrack.jetbrains.com/newIssue?project=QD). We are eager to receive your feedback on the existing Qodana functionality and learn what other features you miss in it. |