setup-maven/README.md

45 lines
1.5 KiB
Markdown
Raw Normal View History

2019-12-07 13:29:25 +00:00
### How To Use
Add this step into workflow
```yaml
jobs:
...
steps:
2022-07-27 04:42:49 +00:00
2019-12-07 13:29:25 +00:00
- name: Set up Maven
uses: stCarolas/setup-maven@v5
2019-12-07 13:29:25 +00:00
with:
2021-09-08 12:21:21 +00:00
maven-version: 3.8.2
2019-12-07 13:29:25 +00:00
```
2022-07-27 04:42:49 +00:00
### Development using [Docker](https://docs.docker.com/)
Clone this repository and build the project with command
```batch
2022-07-28 02:22:21 +00:00
docker run --rm -it -v "%PWD%:/usr/src/app" -w /usr/src/app node:12-alpine /bin/sh -c "npm i --no-bin-links && npm test && npm run build"
2022-07-27 04:42:49 +00:00
```
**Note** that `%PWD%` is the project working directory in `Unix` format, such as: `/c/Users/source/repos/setup-maven`
2022-07-27 15:55:57 +00:00
### Analyze source code with [SonarQube](https://www.sonarqube.org/)
Download [SonarQube Docker image](https://hub.docker.com/_/sonarqube/) and start the server
```batch
docker pull sonarqube:community
docker run --rm -d --name docker-sonarqube -e SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true -p 9000:9000 sonarqube
```
Login to http://localhost:9000/ using `Administrator` account (admin/admin) and configure the project to analyze.
For more details, see: https://docs.sonarqube.org/latest/setup/get-started-2-minutes/
Run `SonarScanner` from [the Docker image](https://hub.docker.com/r/sonarsource/sonar-scanner-cli) to analyze the project
```batch
docker run --rm -it --link docker-sonarqube -v "%PWD%:/usr/src/app" -w /usr/src/app ^
-e "SONAR_HOST_URL=http://docker-sonarqube:9000" -e "SONAR_LOGIN=<projectToken>" sonarsource/sonar-scanner-cli ^
-Dsonar.projectKey=setup-maven -Dsonar.language=js -Dsonar.sources=. "-Dsonar.exclusions=dist/**"
```