nav-java-codestyle

Checkstyle/PMD/Findbugs XML config for NAV

License	MIT License
Categories	Java Languages
GroupId	no.nav
ArtifactId	java-codestyle
Last Version	1.0
Release Date	Apr 8, 2018
Type	jar
Description	nav-java-codestyle Checkstyle/PMD/Findbugs XML config for NAV
Project URL	https://github.com/navikt/nav-java-codestyle
Source Code Management	https://github.com/navikt/nav-java-codestyle

Download java-codestyle

Filename	Size
java-codestyle-1.0.pom
java-codestyle-1.0.jar	9 KB
java-codestyle-1.0-sources.jar	6 KB
java-codestyle-1.0-javadoc.jar	2 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/no.nav/java-codestyle/ -->
<dependency>
    <groupId>no.nav</groupId>
    <artifactId>java-codestyle</artifactId>
    <version>1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/no.nav/java-codestyle/
implementation 'no.nav:java-codestyle:1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/no.nav/java-codestyle/
implementation ("no.nav:java-codestyle:1.0")

Apache Buildr

'no.nav:java-codestyle:jar:1.0'

Apache Ivy

<dependency org="no.nav" name="java-codestyle" rev="1.0">
  <artifact name="java-codestyle" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='no.nav', module='java-codestyle', version='1.0')
)

Scala SBT

libraryDependencies += "no.nav" % "java-codestyle" % "1.0"

Leiningen

[no.nav/java-codestyle "1.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Java code style for NAV projects

This is a repository that contains code style definitions in XML format.

At NAV, we use Sonar for Java code quality analysis. The Sonar instance is not exposed to the public, so we export XML code style definitions and publish them through this library, to be reused in NAV projects.

Making changes to the code style

Tweak the configuration in Sonar. Then, run the script that is included in this git repository:

./fetch-codestyles.sh

The script will download the style definitions as XML files and store them in src/main/resources.

Snapshot versions

Every commit to the master branch (or merged pull request) will trigger a release to the Sonatype OSS snapshot repository.

Releases

In order to release a new version, clone this repository, and

# make sure we're up to date!
git checkout master && git pull

# This is the release command itself
mvn release:prepare

# This will clean up any local temporary files
# that were used during the release.
mvn release:clean

The mvn release:prepare command will ask for a version number to release, as well as which version number to bump to. This command will also do a git push on your behalf, which will update the remote git repository. Then, Travis CI will trigger a build, and deploy the artifact.

First, it will appear in Sonatype OSS releases, before eventually (a couple of minutes later) if is synced to Maven Central.

Contact

If you have any questions, please open an issue on the Github issue tracker.

NAV IT

Arbeids- og velferdsdirektoratet - The Norwegian Labour and Welfare Directorate

Versions

Version
1.0 Apr 8, 2018