Merge pull request #1 from xdev-software/develop

Release

Author: AB-xdev

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -14,9 +14,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/maven-music-plugin/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/music-maven-plugin/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/maven-music-plugin/issues) or [closed](https://github.com/xdev-software/maven-music-plugin/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/music-maven-plugin/issues) or [closed](https://github.com/xdev-software/music-maven-plugin/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/maven-music-plugin/issues) or [closed](https://github.com/xdev-software/maven-music-plugin/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/music-maven-plugin/issues) or [closed](https://github.com/xdev-software/music-maven-plugin/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/maven-music-plugin/issues) or [closed](https://github.com/xdev-software/maven-music-plugin/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/music-maven-plugin/issues) or [closed](https://github.com/xdev-software/music-maven-plugin/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

.run/Run Demo.run.xml

@@ -0,0 +1,32 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Maven Demo" type="MavenRunConfiguration" factoryName="Maven">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="cmdOptions" />
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="install" />
+            </list>
+          </option>
+          <option name="multimoduleDir" />
+          <option name="pomFileName" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="projectsCmdOptionValues">
+            <list />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>

.run/Run Maven Demo.run.xml

@@ -0,0 +1,3 @@
+# 1.0.0
+
+_Initial release_

CHANGELOG.md

@@ -34,10 +34,10 @@ You should have the following things installed:
   * Ensure that the JDK/Java-Version is correct
 
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/maven-music-plugin/release.yml?branch=master)](https://github.com/xdev-software/maven-music-plugin/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/music-maven-plugin/release.yml?branch=master)](https://github.com/xdev-software/music-maven-plugin/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/maven-music-plugin/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/music-maven-plugin/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

CONTRIBUTING.md

@@ -1,12 +1,87 @@
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/maven-music-plugin?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/maven-music-plugin)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/maven-music-plugin/check-build.yml?branch=develop)](https://github.com/xdev-software/maven-music-plugin/actions/workflows/check-build.yml?query=branch%3Adevelop)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_maven-music-plugin&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_maven-music-plugin)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/music-maven-plugin?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/music-maven-plugin)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/music-maven-plugin/check-build.yml?branch=develop)](https://github.com/xdev-software/music-maven-plugin/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_music-maven-plugin&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_music-maven-plugin)
 
-# maven-music-plugin
+# music-maven-plugin
 
+🎵 Plays some background music while Maven is building.
+
+## Usage
+
+### Basic
+
+The following configuration will play some "elevator" music in the background as soon as Maven starts building:
+
+```xml
+<plugin>
+    <groupId>software.xdev</groupId>
+    <artifactId>music-maven-plugin</artifactId>
+    <version>...</version>
+    <!-- You might also want to add <inherited>false</inherited> here to not run it in every child module -->
+    <executions>
+        <execution>
+            <phase>validate</phase>
+            <goals>
+                <goal>music</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+```
+
+### Customizing the music
+
+You can customize the music by adding other sources:
+
+```xml
+<configuration>
+    <sources>
+        <musicSource>
+            <uri>https://incompetech.com/music/royalty-free/mp3-royaltyfree/Corncob.mp3</uri>
+        </musicSource>
+        <musicSource>
+            <!-- Relative to project directory -->
+            <file>my_cool_music.mp3</file>
+        </musicSource>
+        <musicSource>
+            <classpath>/default/Andrew_Codeman_-_03_-_Mussels_short_version.ogg</classpath>
+        </musicSource>
+    </sources>
+    <shuffle>true</shuffle>
+</configuration>
+```
+
+#### Supported codecs
+
+| Codec | Container |
+| --- | --- |
+| [MP3](https://en.wikipedia.org/wiki/MP3) | ``.mp3`` |
+| [Vorbis](https://en.wikipedia.org/wiki/Vorbis) | [``.ogg``](https://en.wikipedia.org/wiki/Ogg) |
+
+> [!NOTE]
+> Container files can also include different codecs.
+> For example ``.ogg`` can also contain ``Opus``, ``Speex``, ``FLAC``, ... which are not supported.
+
+> [!TIP]
+> If you want to convert to supported formats you can do so with [``ffmpeg``](https://www.ffmpeg.org/):<br/>
+> ``ffmpeg -i music.opus music.ogg``
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/maven-music-plugin/releases/latest#Installation)
+[Installation guide for the latest release](https://github.com/xdev-software/music-maven-plugin/releases/latest#Installation)
+
+## Run the demo
+
+> [!WARNING]
+> Might be loud!
+
+* Checkout the repo
+* Run ``mvn install``
+
+## Why?
+This is obviously a joke/fun plugin.<br/>
+You probably shouldn't use it in production or maybe only on April 1st to annoy your colleagues :P
+
+We got the idea during XDEV's christmas party as [rfichtner](https://github.com/rfichtner) always needs more plugins for funnier Maven presentations and was inspired by [this GraalVM issue from joshlong](https://github.com/oracle/graal/issues/5327).
 
 ## Support
 If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
@@ -15,4 +90,6 @@ If you need support as soon as possible and you can't wait for any pull request,
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/maven-music-plugin/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/music-maven-plugin/dependencies)
+
+The license and download information for the [built-in music](./music-maven-plugin/src/main/resources/default/) can be found in [sources.txt](./music-maven-plugin/src/main/resources/default/sources.txt).

README.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/maven-music-plugin/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/music-maven-plugin/security/advisories/new).