Project Signer

Technologies used

Description

You can find all project statuses here Project Statuses

This project serves the purpose of automatically signing all projects from the root

The idea is to use something like:

Short switches

java -jar project-signer.jar -t <template> <tag1>...<tagn> -d <root_path> -ne <no empty>

Long switches

java -jar project-signer.jar --template-location <template> <tag1>...<tagn> --root-directory <root_path> --no-empty <no empty>

Old example:

-l "../project-signer-templates/licenses/APACHE2.template,../project-signer-templates/licenses/ISC.template,../project-signer-templates/licenses/MIT.template" -t "../project-signer-templates/Readme.md" License "About me" -d ../../ 

2020/12/23 Example:

-l "../project-signer-templates/licenses/APACHE2.template,../project-signer-templates/licenses/ISC.template,../project-signer-templates/licenses/MIT.template" -t "../project-signer-templates/Readme.md" License "About me" "Achievements" -d ../../

To summarize, this program will scan all your readme files and standardize name. You may want a generic signature in all your projects and this little runner will do just that!

This command line runner will complete several boiler plate tasks:

Creates all Readme.md files missing - Wherever there is a pom or a package.json file, there should be a Readme.md to explain the purpose of your project. Title will be calculated according to your architecture. The title string is to be extracted from the build files. If multiple build files are present, it will find the name of the project by prioritizing the name of the project in detriment of the artifact name. In order of priority it will look for a title according to the following priority list: Maven, Gradle, SBT and finally NPM.
All indicated paragraph which start on a certain tag will be removed - We consider a whole paragraph according to the ‘#’ notation of the markdown.
Once all Readme.md files have been created or updated, we will finally add the template signature AS IS to the footer of all found cases.
If a Readme file has been generated and a template option (-l) is not null, the it will copy the template file literally to the same destination.
It will also make sure the all legacy License.txt files will be removed.
When running the signAll.sh script, the [yyyy] variable in all licenses will be replaced with the year of the first commit in that repo

All tags are case sensitive, which means you do need to add extra tags in case you have issues with word casing. Once you finally run the above command, please make sure to double check the given signature before committing and pushing to your repos.

Usage in an IDE

The most common form of using this plugin would be something like this as command line parameters:

-t "../project-signer-templates/Readme.md" License "About me" -d ../../

Remember to user profiles dev/prod. No difference at the moment between the different profiles.

Tools

gpg --keyserver hkp://keyserver.ubuntu.com --send-keys <your GPG key>
gpg --list-keys
export GPG_TTY=$(tty)
mvn clean deploy -Prelease
mvn nexus-staging:release  -Prelease

<settings>
    <servers>
        <server>
            <id>ossrh</id>
            <username>your-jira-id</username>
            <password>your-jira-pwd</password>
        </server>
    </servers>
</settings>

Articles

Homepage joaofilipesabinoesperancinha.nl

Title	Release Date
Why not change to Junit Jupiter 5 and AssertJ or Spock? Let’s compare test frameworks! (Under Construction 🚧)	2020/05/28
JDK 14 record classes. A retrospective.	2020/05/24
JDK 15 is coming! Sealing classes is great! (Under Construction 🚧)	2020/05/22
JDK 15 is coming. Let’s have a look at the code changes!	2020/05/19
How to make the best of a slow machine running on limited resources with a Windows environment as a Java Engineer	2020/05/14

Medium

Title	Release Date
The streaming bridges — A Kafka, RabbitMQ, MQTT and CoAP example	2020/05/11
What did they say? — Tweeting with Hosebird Client	2020/04/12
Understanding JWT in REST Services — Let’s improve performance and let’s get physical!	2020/03/20
Chrome OS Guide to go from Zero to DevOps Hero in a nutshell	2020/03/11
Deploying Mancala with Minikube - a beginners guide	2020/03/11
Baking Peixinhos da Horta with ING’s Baker Library	2020/03/01
Comparing WebFlux and Spring MVC with JMeter, Kotlin and Spock	2020/02/17
Monitoring with Grafana, Prometheus and InfluxDB — An airport webcams example	2020/01/28
Reactive Programming applied to Legacy Services — A WebFlux example	2020/01/06
CQRS — Command Query Responsibility Segregation	2019/12/17
Hexagonal Architecture - A Favorite Lyrics Spring Boot — Java Example	2019/12/15

project-signer