Skip to content

Commit febf888

Browse files
Merge pull request #219 from codacy/update-composer-readme-file
TS-241 add procedure to update the phpmd version
2 parents c4e17a2 + 5456683 commit febf888

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,35 @@ docker run -it -v $srcDir:/src <DOCKER_NAME>:<DOCKER_VERSION>
2626

2727
The documentation is updated manually by checking the official documentation rules in the [PHPMD repository](https://github.com/phpmd/phpmd).
2828

29+
## Update version
30+
31+
1. Install composer - (It will create the composer.phar file):
32+
33+
```
34+
curl -sS https://getcomposer.org/installer | php
35+
```
36+
2. Update phpmd version on composer.json:
37+
38+
```
39+
"require": {
40+
"phpmd/phpmd": "x.xx.x"
41+
}
42+
```
43+
44+
3. Run the update command to get the latest versions of the dependencies and to update the composer.lock file:
45+
46+
```
47+
php composer.phar update
48+
```
49+
50+
Note: If you receive a message like this:
51+
52+
```
53+
Could not fetch <URL package>, please review your configured GitHub OAuth token or enter a new one to access private repos" Create a new token here: https://github.com/settings/tokens/new?scopes=&description=Composer to retrieve a token.
54+
```
55+
56+
create the token and paste it to proceed.
57+
2958
## Test
3059

3160
We use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration.

0 commit comments

Comments
 (0)