From aae54f4b3329ce2bdeedf1d3e57637e519ae0d12 Mon Sep 17 00:00:00 2001 From: Tony <3987237+random1223@users.noreply.github.com> Date: Wed, 11 Sep 2024 21:38:45 -0700 Subject: [PATCH 1/4] Added Codety into the tool list. Added Codety into the tool list, Codety Scanner uses PMD as Java code analyzer. Demo: GitHub issue review example: https://github.com/codetyio/codety-scanner/actions/runs/10786005219/job/29912188828 GitHub Pull Request automation example: https://github.com/codetyio/codety-scanner/pull/15#issuecomment-2320351633 --- docs/pages/pmd/userdocs/tools/tools.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/pages/pmd/userdocs/tools/tools.md b/docs/pages/pmd/userdocs/tools/tools.md index 2e49ca89a2..99026e24ae 100644 --- a/docs/pages/pmd/userdocs/tools/tools.md +++ b/docs/pages/pmd/userdocs/tools/tools.md @@ -21,6 +21,15 @@ With Codacy you have PMDJava analysis out-of-the-box, and it is free for open so * Source code: [https://github.com/codacy/codacy-pmdjava](https://github.com/codacy/codacy-pmdjava) * Maintainer: Codacy +### Codety + +[Codety](https://www.codety.io/) provides comprehensive code scanning solution designed to detect code issues for 30+ programming languages and IaC frameworks. It embeds more than 6,000 code analysis rules(including pmd rules) and can detect code smells, vulnerable code, secrets in the code, performance issues, style violations, and more. + +Codety Scanner provides out-of-the-box PMD integration, it is free for personal and commercial use. + +* Homepage: [https://www.codety.io/](https://www.codety.io/) +* Source code: [https://github.com/codetyio/codety-scanner](https://github.com/codetyio/codety-scanner) + ### Codiga [Codiga](https://www.codiga.io) automates code review, check your code quality and helps you manage your technical debt. From 341e089a478bc202673b8c3ee9c4794e30be2eae Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Thu, 12 Sep 2024 10:19:14 +0200 Subject: [PATCH 2/4] Add @random1223 as a contributor --- .all-contributorsrc | 9 ++++ docs/pages/pmd/projectdocs/credits.md | 71 ++++++++++++++------------- 2 files changed, 45 insertions(+), 35 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 1026cb488f..cd388e0ef5 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -7763,6 +7763,15 @@ "contributions": [ "bug" ] + }, + { + "login": "random1223", + "name": "Tony", + "avatar_url": "https://avatars.githubusercontent.com/u/3987237?v=4", + "profile": "https://codety.io/", + "contributions": [ + "doc" + ] } ], "contributorsPerLine": 7, diff --git a/docs/pages/pmd/projectdocs/credits.md b/docs/pages/pmd/projectdocs/credits.md index 33c9770427..1db099d241 100644 --- a/docs/pages/pmd/projectdocs/credits.md +++ b/docs/pages/pmd/projectdocs/credits.md @@ -784,317 +784,318 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Tomas
Tomas

🐛 Tomer Figenblat
Tomer Figenblat

🐛 Tomi De Lucca
Tomi De Lucca

💻 🐛 + Tony
Tony

📖 Torsten Kleiber
Torsten Kleiber

🐛 TrackerSB
TrackerSB

🐛 - Tyson Stewart
Tyson Stewart

🐛 + Tyson Stewart
Tyson Stewart

🐛 Ullrich Hafner
Ullrich Hafner

🐛 Utku Cuhadaroglu
Utku Cuhadaroglu

💻 🐛 Valentin Brandl
Valentin Brandl

🐛 Valeria
Valeria

🐛 Valery Yatsynovich
Valery Yatsynovich

📖 Vasily Anisimov
Vasily Anisimov

🐛 - Vedant Chokshi
Vedant Chokshi

🐛 + Vedant Chokshi
Vedant Chokshi

🐛 Vibhor Goyal
Vibhor Goyal

🐛 Vickenty Fesunov
Vickenty Fesunov

🐛 Victor Noël
Victor Noël

🐛 Vincent Galloy
Vincent Galloy

💻 Vincent HUYNH
Vincent HUYNH

🐛 Vincent Maurin
Vincent Maurin

🐛 - Vincent Privat
Vincent Privat

🐛 + Vincent Privat
Vincent Privat

🐛 Vishhwas
Vishhwas

🐛 Vishv_Android
Vishv_Android

🐛 Vitaly
Vitaly

🐛 Vitaly Polonetsky
Vitaly Polonetsky

🐛 Vojtech Polivka
Vojtech Polivka

🐛 Vsevolod Zholobov
Vsevolod Zholobov

🐛 - Vyom Yadav
Vyom Yadav

💻 + Vyom Yadav
Vyom Yadav

💻 Wang Shidong
Wang Shidong

🐛 Waqas Ahmed
Waqas Ahmed

🐛 Wayne J. Earl
Wayne J. Earl

🐛 Wchenghui
Wchenghui

🐛 Wener
Wener

💻 Will Winder
Will Winder

🐛 - William Brockhus
William Brockhus

💻 🐛 + William Brockhus
William Brockhus

💻 🐛 Wilson Kurniawan
Wilson Kurniawan

🐛 Wim Deblauwe
Wim Deblauwe

🐛 Woongsik Choi
Woongsik Choi

🐛 XenoAmess
XenoAmess

💻 🐛 Yang
Yang

💻 YaroslavTER
YaroslavTER

🐛 - Yasar Shaikh
Yasar Shaikh

💻 + Yasar Shaikh
Yasar Shaikh

💻 Young Chan
Young Chan

💻 🐛 YuJin Kim
YuJin Kim

🐛 Yuri Dolzhenko
Yuri Dolzhenko

🐛 Yurii Dubinka
Yurii Dubinka

🐛 Zoltan Farkas
Zoltan Farkas

🐛 Zustin
Zustin

🐛 - aaronhurst-google
aaronhurst-google

🐛 💻 + aaronhurst-google
aaronhurst-google

🐛 💻 alexmodis
alexmodis

🐛 andreoss
andreoss

🐛 andrey81inmd
andrey81inmd

💻 🐛 anicoara
anicoara

🐛 arunprasathav
arunprasathav

🐛 asiercamara
asiercamara

🐛 - astillich-igniti
astillich-igniti

💻 + astillich-igniti
astillich-igniti

💻 avesolovksyy
avesolovksyy

🐛 avishvat
avishvat

🐛 avivmu
avivmu

🐛 axelbarfod1
axelbarfod1

🐛 b-3-n
b-3-n

🐛 balbhadra9
balbhadra9

🐛 - base23de
base23de

🐛 + base23de
base23de

🐛 bergander
bergander

🐛 💻 berkam
berkam

💻 🐛 breizh31
breizh31

🐛 caesarkim
caesarkim

🐛 carolyujing
carolyujing

🐛 cbfiddle
cbfiddle

🐛 - cesares-basilico
cesares-basilico

🐛 + cesares-basilico
cesares-basilico

🐛 chrite
chrite

🐛 ciufudean
ciufudean

📖 cobratbq
cobratbq

🐛 coladict
coladict

🐛 cosmoJFH
cosmoJFH

🐛 cristalp
cristalp

🐛 - crunsk
crunsk

🐛 + crunsk
crunsk

🐛 cwholmes
cwholmes

🐛 cyberjj999
cyberjj999

🐛 cyw3
cyw3

🐛 📖 d1ss0nanz
d1ss0nanz

🐛 dague1
dague1

📖 dalizi007
dalizi007

💻 - danbrycefairsailcom
danbrycefairsailcom

🐛 + danbrycefairsailcom
danbrycefairsailcom

🐛 dariansanity
dariansanity

🐛 darrenmiliband
darrenmiliband

🐛 davidburstrom
davidburstrom

🐛 dbirkman-paloalto
dbirkman-paloalto

🐛 deepak-patra
deepak-patra

🐛 dependabot[bot]
dependabot[bot]

💻 🐛 - dinesh150
dinesh150

🐛 + dinesh150
dinesh150

🐛 diziaq
diziaq

🐛 dreaminpast123
dreaminpast123

🐛 duanyanan
duanyanan

🐛 dutt-sanjay
dutt-sanjay

🐛 duursma
duursma

💻 dylanleung
dylanleung

🐛 - dzeigler
dzeigler

🐛 + dzeigler
dzeigler

🐛 eant60
eant60

🐛 ekkirala
ekkirala

🐛 emersonmoura
emersonmoura

🐛 emouty
emouty

💻 eugenepugach
eugenepugach

🐛 fairy
fairy

🐛 - filiprafalowicz
filiprafalowicz

💻 + filiprafalowicz
filiprafalowicz

💻 flxbl-io
flxbl-io

💵 foxmason
foxmason

🐛 frankegabor
frankegabor

🐛 frankl
frankl

🐛 freafrea
freafrea

🐛 fsapatin
fsapatin

🐛 - gearsethenry
gearsethenry

🐛 + gearsethenry
gearsethenry

🐛 gracia19
gracia19

🐛 guo fei
guo fei

🐛 gurmsc5
gurmsc5

🐛 gwilymatgearset
gwilymatgearset

💻 🐛 haigsn
haigsn

🐛 hemanshu070
hemanshu070

🐛 - henrik242
henrik242

🐛 + henrik242
henrik242

🐛 hongpuwu
hongpuwu

🐛 hvbtup
hvbtup

💻 🐛 igniti GmbH
igniti GmbH

🐛 ilovezfs
ilovezfs

🐛 itaigilo
itaigilo

🐛 jakivey32
jakivey32

🐛 - jbennett2091
jbennett2091

🐛 + jbennett2091
jbennett2091

🐛 jcamerin
jcamerin

🐛 jkeener1
jkeener1

🐛 jmetertea
jmetertea

🐛 johnra2
johnra2

💻 johnzhao9
johnzhao9

🐛 josemanuelrolon
josemanuelrolon

💻 🐛 - kabroxiko
kabroxiko

💻 🐛 + kabroxiko
kabroxiko

💻 🐛 karthikaiyasamy
karthikaiyasamy

📖 karwer
karwer

🐛 kaulonline
kaulonline

🐛 kdaemonv
kdaemonv

🐛 kdebski85
kdebski85

🐛 💻 kenji21
kenji21

💻 🐛 - kfranic
kfranic

🐛 + kfranic
kfranic

🐛 khalidkh
khalidkh

🐛 koalalam
koalalam

🐛 krzyk
krzyk

🐛 lasselindqvist
lasselindqvist

🐛 lgemeinhardt
lgemeinhardt

🐛 lihuaib
lihuaib

🐛 - liqingjun123
liqingjun123

🐛 + liqingjun123
liqingjun123

🐛 lonelyma1021
lonelyma1021

🐛 lpeddy
lpeddy

🐛 lujiefsi
lujiefsi

💻 lukelukes
lukelukes

💻 lyriccoder
lyriccoder

🐛 marcelmore
marcelmore

🐛 - matchbox
matchbox

🐛 + matchbox
matchbox

🐛 matthiaskraaz
matthiaskraaz

🐛 meandonlyme
meandonlyme

🐛 mikesive
mikesive

🐛 milossesic
milossesic

🐛 mluckam
mluckam

💻 🐛 mohan-chinnappan-n
mohan-chinnappan-n

💻 - mriddell95
mriddell95

🐛 + mriddell95
mriddell95

🐛 mrlzh
mrlzh

🐛 msloan
msloan

🐛 mucharlaravalika
mucharlaravalika

🐛 mvenneman
mvenneman

🐛 nareshl119
nareshl119

🐛 nicolas-harraudeau-sonarsource
nicolas-harraudeau-sonarsource

🐛 - noerremark
noerremark

🐛 + noerremark
noerremark

🐛 novsirion
novsirion

🐛 nwcm
nwcm

📖 🐛 💻 oggboy
oggboy

🐛 oinume
oinume

🐛 orimarko
orimarko

💻 🐛 pablogomez2197
pablogomez2197

🐛 - pacvz
pacvz

💻 + pacvz
pacvz

💻 pallavi agarwal
pallavi agarwal

🐛 parksungrin
parksungrin

🐛 patpatpat123
patpatpat123

🐛 patriksevallius
patriksevallius

🐛 pbrajesh1
pbrajesh1

🐛 phoenix384
phoenix384

🐛 - piotrszymanski-sc
piotrszymanski-sc

💻 + piotrszymanski-sc
piotrszymanski-sc

💻 plan3d
plan3d

🐛 poojasix
poojasix

🐛 prabhushrikant
prabhushrikant

🐛 pujitha8783
pujitha8783

🐛 r-r-a-j
r-r-a-j

🐛 raghujayjunk
raghujayjunk

🐛 - rajeshveera
rajeshveera

🐛 + rajeshveera
rajeshveera

🐛 rajeswarreddy88
rajeswarreddy88

🐛 recdevs
recdevs

🐛 reudismam
reudismam

💻 🐛 rijkt
rijkt

🐛 rillig-tk
rillig-tk

🐛 rmohan20
rmohan20

💻 🐛 - rnveach
rnveach

🐛 + rnveach
rnveach

🐛 rxmicro
rxmicro

🐛 ryan-gustafson
ryan-gustafson

💻 🐛 sabi0
sabi0

🐛 scais
scais

🐛 schosin
schosin

🐛 screamingfrog
screamingfrog

💵 - sebbASF
sebbASF

🐛 + sebbASF
sebbASF

🐛 sergeygorbaty
sergeygorbaty

💻 shilko2013
shilko2013

🐛 shiomiyan
shiomiyan

📖 simeonKondr
simeonKondr

🐛 snajberk
snajberk

🐛 sniperrifle2004
sniperrifle2004

🐛 - snuyanzin
snuyanzin

🐛 💻 + snuyanzin
snuyanzin

🐛 💻 soloturn
soloturn

🐛 soyodream
soyodream

🐛 sratz
sratz

🐛 stonio
stonio

🐛 sturton
sturton

💻 🐛 sudharmohan
sudharmohan

🐛 - suruchidawar
suruchidawar

🐛 + suruchidawar
suruchidawar

🐛 svenfinitiv
svenfinitiv

🐛 szymanp23
szymanp23

🐛 💻 tashiscool
tashiscool

🐛 test-git-hook
test-git-hook

🐛 testation21
testation21

💻 🐛 thanosa
thanosa

🐛 - tiandiyixian
tiandiyixian

🐛 + tiandiyixian
tiandiyixian

🐛 tobwoerk
tobwoerk

🐛 tprouvot
tprouvot

🐛 💻 trentchilders
trentchilders

🐛 triandicAnt
triandicAnt

🐛 trishul14
trishul14

🐛 tsui
tsui

🐛 - wangzitom12306
wangzitom12306

🐛 + wangzitom12306
wangzitom12306

🐛 winhkey
winhkey

🐛 witherspore
witherspore

🐛 wjljack
wjljack

🐛 wuchiuwong
wuchiuwong

🐛 xingsong
xingsong

🐛 xioayuge
xioayuge

🐛 - xnYi9wRezm
xnYi9wRezm

💻 🐛 + xnYi9wRezm
xnYi9wRezm

💻 🐛 xuanuy
xuanuy

🐛 xyf0921
xyf0921

🐛 yalechen-cyw3
yalechen-cyw3

🐛 yasuharu-sato
yasuharu-sato

🐛 zenglian
zenglian

🐛 zgrzyt93
zgrzyt93

💻 🐛 - zh3ng
zh3ng

🐛 + zh3ng
zh3ng

🐛 zt_soft
zt_soft

🐛 ztt79
ztt79

🐛 zzzzfeng
zzzzfeng

🐛 From 537148c90a98e11b9f11e905bb36f10df2ff8e13 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Thu, 12 Sep 2024 10:29:51 +0200 Subject: [PATCH 3/4] [doc] Reformatting tools.md and ci.md --- docs/pages/pmd/userdocs/tools/ci.md | 12 ++++---- docs/pages/pmd/userdocs/tools/tools.md | 41 +++++++++++++++----------- 2 files changed, 30 insertions(+), 23 deletions(-) diff --git a/docs/pages/pmd/userdocs/tools/ci.md b/docs/pages/pmd/userdocs/tools/ci.md index 513374f26e..cccb1b41d6 100644 --- a/docs/pages/pmd/userdocs/tools/ci.md +++ b/docs/pages/pmd/userdocs/tools/ci.md @@ -7,7 +7,7 @@ author: Romain PELISSE ## Introduction -PMD can be integrate through some of the Continuous Integration tools that exist now. +PMD can be integrated through some of the Continuous Integration tools that exist now. Here is a list of known (to us) plugin to do so. ## Jenkins Plugin @@ -16,12 +16,12 @@ Here is a list of known (to us) plugin to do so. [Warnings Next Generation](https://plugins.jenkins.io/warnings-ng/) plugin for Jenkins. It supports PMD among many other linting tools. -* Homepage: https://plugins.jenkins.io/warnings-ng/ -* Source: https://github.com/jenkinsci/warnings-ng-plugin and https://github.com/jenkinsci/analysis-model +* Homepage: +* Source: and ## Continuum -Continuum does not have a plugin for PMD per see, but can failed the build according to the +Continuum does not have a plugin for PMD per see, but can fail the build according to the result of the PMD maven plugin. ## GitHub Action @@ -30,7 +30,9 @@ See [Other Tools / Integrations](pmd_userdocs_tools.html#github-actions) ## MegaLinter -[🦙 Mega-Linter](https://oxsecurity.github.io/megalinter/latest/) analyzes 50 languages, 22 formats, 21 tooling formats, excessive copy-pastes, spelling mistakes and security issues in your repository sources with a GitHub Action, other CI tools or locally. +[🦙 Mega-Linter](https://oxsecurity.github.io/megalinter/latest/) analyzes 50 languages, 22 formats, 21 tooling +formats, excessive copy-pastes, spelling mistakes and security issues in your repository sources with a +GitHub Action, other CI tools or locally. It [natively embeds PMD](https://oxsecurity.github.io/megalinter/latest/descriptors/java_pmd/). diff --git a/docs/pages/pmd/userdocs/tools/tools.md b/docs/pages/pmd/userdocs/tools/tools.md index 99026e24ae..ace5b4e816 100644 --- a/docs/pages/pmd/userdocs/tools/tools.md +++ b/docs/pages/pmd/userdocs/tools/tools.md @@ -12,45 +12,50 @@ author: David Dixon-Peugh ### Codacy [Codacy](https://www.codacy.com/) automates code reviews and monitors code quality on every commit and pull request. -It gives visibility into the technical debt and it can track code style and security issues, code coverage, code duplication, cyclomatic complexity and enforce best practices. +It gives visibility into the technical debt and can track code style and security issues, code coverage, code +duplication, cyclomatic complexity and enforce best practices. Codacy is static analysis without the hassle. With Codacy you have PMDJava analysis out-of-the-box, and it is free for open source projects. -* Homepage: [https://www.codacy.com/](https://www.codacy.com/) -* Source code: [https://github.com/codacy/codacy-pmdjava](https://github.com/codacy/codacy-pmdjava) +* Homepage: +* Source code: * Maintainer: Codacy ### Codety -[Codety](https://www.codety.io/) provides comprehensive code scanning solution designed to detect code issues for 30+ programming languages and IaC frameworks. It embeds more than 6,000 code analysis rules(including pmd rules) and can detect code smells, vulnerable code, secrets in the code, performance issues, style violations, and more. +[Codety](https://www.codety.io/) provides comprehensive code scanning solution designed to detect code issues for +30+ programming languages and IaC frameworks. It embeds more than 6,000 code analysis rules (including pmd rules) +and can detect code smells, vulnerable code, secrets in the code, performance issues, style violations, and more. -Codety Scanner provides out-of-the-box PMD integration, it is free for personal and commercial use. +Codety Scanner provides out-of-the-box PMD integration, it is free for personal and commercial use. -* Homepage: [https://www.codety.io/](https://www.codety.io/) -* Source code: [https://github.com/codetyio/codety-scanner](https://github.com/codetyio/codety-scanner) +* Homepage: +* Source code: ### Codiga -[Codiga](https://www.codiga.io) automates code review, check your code quality and helps you manage your technical debt. -It is integrated with GitHub, GitLab and Bitbucket. The platform also analyzes code directly in your IDE using its integration -plugins for VS Code and IntelliJ, providing a consistent analysis along your development cycle (from the IDE to the CI/CD pipeline). +[Codiga](https://www.codiga.io) automates code review, check your code quality and helps you manage your +technical debt. It is integrated with GitHub, GitLab and Bitbucket. The platform also analyzes code directly in +your IDE using its integration plugins for VS Code and IntelliJ, providing a consistent analysis along your +development cycle (from the IDE to the CI/CD pipeline). Codiga uses PMD to check Java and Apex code. -* Homepage: [https://www.codiga.io](https://www.codiga.io) -* Documentation: [https://doc.codiga.io](https://doc.codiga.io) +* Homepage: +* Documentation: ### GitHub Actions PMD provides its own GitHub Action, that can be integrated in custom workflows. -It can execute PMD with your own ruleset against your project. It creates a [SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) -report which is uploaded as a build artifact. Furthermore the build can be failed based on the number of violations. +It can execute PMD with your own ruleset against your project. It creates a +[SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) report which is uploaded as a +build artifact. Furthermore, the build can be failed based on the number of violations. The action can also be used as a code scanner to create "Code scanning alerts". -* Homepage: [pmd/pmd-github-action](https://github.com/pmd/pmd-github-action) +* Homepage: ### TCA @@ -66,9 +71,9 @@ code quality, and be more conducive to inheriting an excellent team code culture With TCA you have PMD analysis out-of-the-box, and it is open source under the MIT license. -* Homepage: [http://tca.tencent.com/](http://tca.tencent.com/) -* Source code: [https://github.com/Tencent/CodeAnalysis](https://github.com/Tencent/CodeAnalysis) -* Documentation: [https://tencent.github.io/CodeAnalysis](https://tencent.github.io/CodeAnalysis) +* Homepage: +* Source code: +* Documentation: * Maintainer: TCA ## IDE Integrations From b4101999922196cb5dbc22d949190a2ecf605f77 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Thu, 12 Sep 2024 10:30:04 +0200 Subject: [PATCH 4/4] [doc] Update release notes (#5208) --- docs/pages/release_notes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index 53b4529c76..7882072c72 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -26,6 +26,7 @@ This is a {{ site.pmd.release_type }} release. ### 🚨 API Changes ### ✨ External Contributions +* [#5208](https://github.com/pmd/pmd/pull/5208): \[doc] Added Codety to "Tools / Integrations" - [Tony](https://github.com/random1223) (@random1223) {% endtocmaker %}