feature/default active profile

README.md

@@ -66,7 +66,6 @@ Reference: [Maven Settings > Repositories](http://maven.apache.org/settings.html
 
 Reference: [Maven Settings > Plugin Repositories](http://maven.apache.org/settings.html#Plugin_Repositories)
 
-
 ### `plugin_groups`
 **Optional** json array of plugin groups to add to settings.xml
 
@@ -79,7 +78,17 @@ The `profile` element in the `settings.xml` is a truncated version of the `pom.x
 
 Reference: [Maven Settings > Profiles](http://maven.apache.org/settings.html#profiles)
 
-## Simple Usage
+
+### `activeProfiles`
+**Optional** json array of active profiles to add to settings.xml
+
+Set of `activeProfile` elements, which each have a value of a `profile` `id`. Any `profile` `id` defined as an `activeProfile` will be active, regardless of any environment settings. If no matching profile is found nothing will happen. For example, if `env-test` is an `activeProfile`, a profile in a `pom.xml` (or `profile.xml`) with a corresponding `id` will be active. If no such profile is found then execution will continue as normal.
+
+Reference: [Maven Settings > Active Profiles](https://maven.apache.org/settings.html#Active_Profiles)
+
+---
+
+## Basic Usage
 
 ````yaml
 - name: maven-settings-xml-action
@@ -90,7 +99,7 @@ Reference: [Maven Settings > Profiles](http://maven.apache.org/settings.html#pro
     servers: '[{ "id": "some-server", "username": "some.user", "password": "some.password" }]'
 ````
 
-## Simple settings.xml
+**Output**
 
 ````xml
 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 
@@ -131,6 +140,8 @@ Reference: [Maven Settings > Profiles](http://maven.apache.org/settings.html#pro
 </settings>
 ````
 
+----
+
 ## Full Usage
 
 ````yaml
@@ -205,10 +216,13 @@ Reference: [Maven Settings > Profiles](http://maven.apache.org/settings.html#pro
         "some.plugin.group.id", 
         "some.other.plugin.group.id"
       ]
-
+    active_profiles: |
+      [ 
+        "some-profile"
+      ]
 ````
 
-## Full settings.xml
+**Output**
 
 ````xml
 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 
@@ -217,7 +231,7 @@ Reference: [Maven Settings > Profiles](http://maven.apache.org/settings.html#pro
                               http://maven.apache.org/xsd/settings-1.0.0.xsd">
 
     <activeProfiles>
-        <activeProfile>github</activeProfile>
+        <activeProfile>some-profile</activeProfile>
     </activeProfiles>
 
     <profiles>

action.yml

@@ -22,6 +22,8 @@ inputs:
   plugin_groups:
     description: 'json array of plugin groups to add to settings.xml'
     required: false
+  active_profiles:
+    description: 'json array of profile ids to add to settings.xml'
 runs:
   using: 'node12'
   main: 'dist/index.js'

dist/index.js

@@ -3460,6 +3460,10 @@ function getDefaultRepositoryTemplate() {
     return getTemplate('../template', 'default-repository.xml');
 }
 
+function getDefaultActiveProfileTemplate() {
+    return getTemplate('../template', 'default-active-profile.xml');
+}
+
 function getTemplate(filepath, filename) {
     var templatePath = path.join(__dirname, filepath, filename);
     var template = fs.readFileSync(templatePath).toString();
@@ -3490,6 +3494,7 @@ function writeSettings(settingsPath, templateXml) {
 }
 
 function update(templateXml) { 
+    this.updateActiveProfiles(templateXml);
     this.updateServers(templateXml);
     this.updateMirrors(templateXml);
     this.updateRepositories(templateXml);
@@ -3498,6 +3503,41 @@ function update(templateXml) {
     this.updatePluginGroups(templateXml)
 }
 
+function updateActiveProfiles(templateXml) { 
+
+    var activeProfilesInput = core.getInput('active_profiles');
+
+    if (!activeProfilesInput) {
+        applyDefaultActiveProfile(templateXml);
+        return;
+    }
+
+    var activeProfiles = JSON.parse(activeProfilesInput);
+
+    if (activeProfiles.length == 0) {
+        applyDefaultActiveProfile(templateXml);
+        return;
+    }
+
+    // apply custom repostories
+    activeProfiles.forEach((activeProfileInput) => {
+        activeProfileXml = templateXml.createElement("activeProfile");
+        activeProfileXml.textContent = activeProfileInput;
+        templateXml
+            .getElementsByTagName('activeProfiles')[0]
+            .appendChild(activeProfileXml);
+    });
+
+}
+
+function applyDefaultActiveProfile(templateXml) {
+    var defaultActiveProfile = getDefaultActiveProfileTemplate();
+
+    templateXml
+        .getElementsByTagName('activeProfiles')[0]
+        .appendChild(defaultActiveProfile);
+}
+
 function updateServers(templateXml) {
     var serversInput = core.getInput('servers');
 
@@ -3707,18 +3747,17 @@ function objectToXml(obj) {
 
 module.exports = {
     getSettingsTemplate,
-    getDefaultRepositoryTemplate,
     getTemplate,
     formatSettings,
     writeSettings,
     update,
+    updateActiveProfiles,
     updateServers,
     updateMirrors,
     updateRepositories,
     updatePluginRepositories,
     updateProfiles,
-    updatePluginGroups,
-    objectToXml
+    updatePluginGroups
 }
 
 

dist/template/default-active-profile.xml

@@ -0,0 +1 @@
+<activeProfile>github</activeProfile>

dist/template/settings.xml

@@ -3,9 +3,7 @@
     xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                         http://maven.apache.org/xsd/settings-1.0.0.xsd">
 
-  <activeProfiles>
-    <activeProfile>github</activeProfile>
-  </activeProfiles>
+  <activeProfiles/>
 
   <profiles>
     <profile>

src/settings.js

@@ -13,6 +13,10 @@ function getDefaultRepositoryTemplate() {
     return getTemplate('../template', 'default-repository.xml');
 }
 
+function getDefaultActiveProfileTemplate() {
+    return getTemplate('../template', 'default-active-profile.xml');
+}
+
 function getTemplate(filepath, filename) {
     var templatePath = path.join(__dirname, filepath, filename);
     var template = fs.readFileSync(templatePath).toString();
@@ -43,6 +47,7 @@ function writeSettings(settingsPath, templateXml) {
 }
 
 function update(templateXml) { 
+    this.updateActiveProfiles(templateXml);
     this.updateServers(templateXml);
     this.updateMirrors(templateXml);
     this.updateRepositories(templateXml);
@@ -51,6 +56,41 @@ function update(templateXml) {
     this.updatePluginGroups(templateXml)
 }
 
+function updateActiveProfiles(templateXml) { 
+
+    var activeProfilesInput = core.getInput('active_profiles');
+
+    if (!activeProfilesInput) {
+        applyDefaultActiveProfile(templateXml);
+        return;
+    }
+
+    var activeProfiles = JSON.parse(activeProfilesInput);
+
+    if (activeProfiles.length == 0) {
+        applyDefaultActiveProfile(templateXml);
+        return;
+    }
+
+    // apply custom repostories
+    activeProfiles.forEach((activeProfileInput) => {
+        activeProfileXml = templateXml.createElement("activeProfile");
+        activeProfileXml.textContent = activeProfileInput;
+        templateXml
+            .getElementsByTagName('activeProfiles')[0]
+            .appendChild(activeProfileXml);
+    });
+
+}
+
+function applyDefaultActiveProfile(templateXml) {
+    var defaultActiveProfile = getDefaultActiveProfileTemplate();
+
+    templateXml
+        .getElementsByTagName('activeProfiles')[0]
+        .appendChild(defaultActiveProfile);
+}
+
 function updateServers(templateXml) {
     var serversInput = core.getInput('servers');
 
@@ -260,16 +300,15 @@ function objectToXml(obj) {
 
 module.exports = {
     getSettingsTemplate,
-    getDefaultRepositoryTemplate,
     getTemplate,
     formatSettings,
     writeSettings,
     update,
+    updateActiveProfiles,
     updateServers,
     updateMirrors,
     updateRepositories,
     updatePluginRepositories,
     updateProfiles,
-    updatePluginGroups,
-    objectToXml
+    updatePluginGroups
 }

template/default-active-profile.xml

@@ -0,0 +1 @@
+<activeProfile>github</activeProfile>

template/settings.xml

@@ -3,9 +3,7 @@
     xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                         http://maven.apache.org/xsd/settings-1.0.0.xsd">
 
-  <activeProfiles>
-    <activeProfile>github</activeProfile>
-  </activeProfiles>
+  <activeProfiles/>
 
   <profiles>
     <profile>

test/resources/when-active-profiles-empty.xml

@@ -0,0 +1,35 @@
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
+                        http://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+    <activeProfiles>
+        <activeProfile>github</activeProfile>
+    </activeProfiles>
+
+    <profiles>
+        <profile>
+            <id>github</id>
+            <repositories>
+                <repository>
+                    <id>central</id>
+                    <name>Maven Central</name>
+                    <url>https://repo1.maven.org/maven2</url>
+                    <releases>
+                        <enabled>true</enabled>
+                    </releases>
+                    <snapshots>
+                        <enabled>false</enabled>
+                    </snapshots>
+                </repository>
+            </repositories>
+            <pluginRepositories/>
+        </profile>
+    </profiles>
+
+    <servers/>
+
+    <mirrors/>
+
+    <pluginGroups/>
+
+</settings>

test/resources/when-active-profiles-missing.xml

@@ -0,0 +1,35 @@
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
+                        http://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+    <activeProfiles>
+        <activeProfile>github</activeProfile>
+    </activeProfiles>
+
+    <profiles>
+        <profile>
+            <id>github</id>
+            <repositories>
+                <repository>
+                    <id>central</id>
+                    <name>Maven Central</name>
+                    <url>https://repo1.maven.org/maven2</url>
+                    <releases>
+                        <enabled>true</enabled>
+                    </releases>
+                    <snapshots>
+                        <enabled>false</enabled>
+                    </snapshots>
+                </repository>
+            </repositories>
+            <pluginRepositories/>
+        </profile>
+    </profiles>
+
+    <servers/>
+
+    <mirrors/>
+
+    <pluginGroups/>
+
+</settings>

test/resources/when-active-profiles-present.xml

@@ -0,0 +1,35 @@
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
+                        http://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+    <activeProfiles>
+        <activeProfile>foo-bar</activeProfile>
+    </activeProfiles>
+
+    <profiles>
+        <profile>
+            <id>github</id>
+            <repositories>
+                <repository>
+                    <id>central</id>
+                    <name>Maven Central</name>
+                    <url>https://repo1.maven.org/maven2</url>
+                    <releases>
+                        <enabled>true</enabled>
+                    </releases>
+                    <snapshots>
+                        <enabled>false</enabled>
+                    </snapshots>
+                </repository>
+            </repositories>
+            <pluginRepositories/>
+        </profile>
+    </profiles>
+
+    <servers/>
+
+    <mirrors/>
+
+    <pluginGroups/>
+
+</settings>