Merge pull request #26 from conveyal/dev

New release

Author: evansiroky

.travis.yml

@@ -4,7 +4,7 @@ cache:
 notifications:
   email: false
 node_js:
-  - '8'
+  - '10'
 after_success:
   - npm run semantic-release
 branches:

README.md

@@ -92,6 +92,12 @@ after_success:
   - semantic-release --prepare @conveyal/maven-semantic-release --publish @semantic-release/github,@conveyal/maven-semantic-release --verify-conditions @semantic-release/github,@conveyal/maven-semantic-release --verify-release @conveyal/maven-semantic-release --use-conveyal-workflow --dev-branch=dev --disable-snapshot-skip-ci --disable-final-skip-ci
 ```
 
+If you use the conveyal workflow just the updated `pom.xml` will be part of the commit. To add more files to the commit (e.g. a CHANGELOG.md generated by a different plugin) you can specify those via the parameter `--additionalFilesToCommit`. This parameter accepts a list of filenames and will include them in the commit. Example:  
+```
+after_success:
+  - semantic-release --prepare @conveyal/maven-semantic-release --publish @semantic-release/github,@conveyal/maven-semantic-release --verify-conditions @semantic-release/github,@conveyal/maven-semantic-release --verify-release @conveyal/maven-semantic-release --use-conveyal-workflow --dev-branch=dev --additionalFilesToCommit CHANGELOG.md,readme.txt
+```
+
 #### before_install
 
 Be sure to include the import of your signing keys.  If you followed everything correctly in step 4 you should have something like the following added to your .travis.yml file:
@@ -132,3 +138,5 @@ Create a Github token that will be used to make commits and create releases.  Ad
 ## Which `mvn` will be used
 
 This plugin uses the `mvn` command in your `PATH`. If you have [maven-wrapper script](https://github.com/takari/maven-wrapper) at the project root directory, this plugin will use that instead.
+
+

lib/git.js

@@ -122,6 +122,12 @@ async function saveChangesToPomXml (context, versionStr) {
     logger.log('INFO: no multi-project pom.xml files found to add to commit')
   }
 
+  if (options.additionalFilesToCommit !== undefined && options.additionalFilesToCommit.length > 0) {
+    logger.log('adding additional files to commit: ' + options.additionalFilesToCommit)
+    const additionalFiles = options.additionalFilesToCommit.split(',')
+    await add(additionalFiles, execaOpts)
+  }
+
   logger.log('committing changes')
   await commit(commitMessage, execaOpts)
   process.stdout.write('\n')

package.json

@@ -24,7 +24,7 @@
     "xml2js-es6-promise": "^1.1.1"
   },
   "devDependencies": {
-    "mastarm": "^4.1.0",
+    "mastarm": "^5.1.3",
     "semantic-release": "^15.12.3"
   },
   "peerDependencies": {