Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the license tag and adding the information to perform the release #2

Merged
merged 2 commits into from
Apr 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
target/

release.properties

.idea/
*.iml
40 changes: 40 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
= Narayana Checkstyle Configuration

This repository contains the checkstyle rules used by some narayana projects.

== How to build

Compile with Maven.

[source,bash]
----
mvn clean install
----

== How to release

Release is performed to https://repository.jboss.org/nexus/[JBoss Nexus].

Credentials for release needs to be setup in the `~/.m2/settings.xml` (or settings defined with `-s` parameter)
where you link the repository id `jboss-releases-repository` with the username/password.

```xml
<server>
<id>jboss-releases-repository</id>
<username>[username]</username>
<password>[password for jboss nexus connection]</password>
</server>
```

As the next step run the `mvn release` and proceed standard
http://maven.apache.org/maven-release/maven-release-plugin/usage.html[steps for maven release plugin].

* `git checkout master; git fetch upstream master; git rebase upstream/master; git push upstream master`
* `mvn javadoc:javadoc` - verification that there won't be any javadoc errors during `release:perform`

* `mvn release:clean`
* `mvn release:prepare`
* `mvn release:perform`

Dry run: `mvn release:prepare -DdryRun=true`

1 change: 0 additions & 1 deletion README.md

This file was deleted.

24 changes: 18 additions & 6 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,23 @@
<version>1.0.0.Final-SNAPSHOT</version>

<licenses>
<licenses>
<license>
<name>LGPL 2.1</name>
<url>http://www.gnu.org/licenses/lgpl-2.1.html</url>
</license>
</licenses>
<license>
<name>LGPL 2.1</name>
<url>http://www.gnu.org/licenses/lgpl-2.1.html</url>
</license>
</licenses>

<distributionManagement>
<repository>
<id>jboss-releases-repository</id>
<name>JBoss Release Repository</name>
<url>https://repository.jboss.org/nexus/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>
<scm>
<connection>scm:git:https://github.com/jbosstm/narayana-checkstyle-config.git</connection>
<url>https://github.com/jbosstm/narayana-checkstyle-config</url>
<developerConnection>scm:git:https://github.com/jbosstm/narayana-checkstyle-config.git</developerConnection>
<tag>HEAD</tag>
</scm>
</project>