Merge branch 'release/5.0.0'

Jenkinsfile

@@ -8,7 +8,7 @@ pipeline {
         GRADLE_USER_HOME = "$WORKSPACE/.gradle"
         ARTIFACTORY_CREDENTIALS = credentials('mdk-artifactory-credentials')
         TESTRAIL_CREDENTIALS = credentials('mdk-testrail-credentials')
-        BUILD_ACCESS = credentials('mdk-build-access')
+        BUILD_PROFILE = credentials('mdk-build-access')
         TESTRAIL_HOST = credentials('mdk-testrail-host')
         TESTRAIL_SUITE_ID = credentials('mdk-testrail-suite-id')
         ARTIFACTORY_URL = credentials('mdk-artifactory-url')
@@ -21,7 +21,7 @@ pipeline {
                 echo 'TAG_NAME = $TAG_NAME'
                 sh './gradlew \
                     -PbuildNumber=$BUILD_NUMBER \
-                    -PbuildAccess=$BUILD_ACCESS \
+                    -PbuildProfile=$BUILD_PROFILE \
                     -PbuildTag=$TAG_NAME \
                     -PartifactoryUrl=$ARTIFACTORY_URL \
                     -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
@@ -35,7 +35,7 @@ pipeline {
             steps {
                 sh './gradlew \
                     -PbuildNumber=$BUILD_NUMBER \
-                    -PbuildAccess=$BUILD_ACCESS \
+                    -PbuildProfile=$BUILD_PROFILE \
                     -PbuildTag=$TAG_NAME \
                     -PartifactoryUrl=$ARTIFACTORY_URL \
                     -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
@@ -49,7 +49,7 @@ pipeline {
             steps {
                 sh 'xvfb-run ./gradlew \
                     -PbuildNumber=$BUILD_NUMBER \
-                    -PbuildAccess=$BUILD_ACCESS \
+                    -PbuildProfile=$BUILD_PROFILE \
                     -PbuildTag=$TAG_NAME \
                     -PartifactoryUrl=$ARTIFACTORY_URL \
                     -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
@@ -69,7 +69,7 @@ pipeline {
             steps {
                 sh './gradlew \
                 -PbuildNumber=$BUILD_NUMBER \
-                -PbuildAccess=$BUILD_ACCESS \
+                -PbuildProfile=$BUILD_PROFILE \
                 -PbuildTag=$TAG_NAME \
                 -PartifactoryUrl=$ARTIFACTORY_URL \
                 -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
@@ -86,7 +86,7 @@ pipeline {
             steps {
                 sh './gradlew \
                 -PbuildNumber=$BUILD_NUMBER \
-                -PbuildAccess=$BUILD_ACCESS \
+                -PbuildProfile=$BUILD_PROFILE \
                 -PbuildTag=$TAG_NAME \
                 -PartifactoryUrl=$ARTIFACTORY_URL \
                 -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \

README.md

@@ -1,6 +1,6 @@
 # Cameo Model Development Kit (MDK)
 
-[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Open-MBEE/mdk?label=download)](https://github.com/Open-MBEE/mdk/releases/latest) [![Jira](https://img.shields.io/badge/issues-jira-blue)](https://openmbee.atlassian.net/browse/MDK) [![CircleCI](https://circleci.com/gh/Open-MBEE/mdk.svg?style=shield)](https://circleci.com/gh/Open-MBEE/mdk) [![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/Open-MBEE/mdk.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Open-MBEE/mdk/context:java)
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Open-MBEE/mdk?label=download)](https://github.com/Open-MBEE/mdk/releases/latest) [![Maven Central](https://img.shields.io/maven-central/v/org.openmbee.mdk.magic/mdk)](https://search.maven.org/artifact/org.openmbee.mdk.magic/mdk) [![Jira](https://img.shields.io/badge/issues-jira-blue)](https://openmbee.atlassian.net/browse/MDK) [![CircleCI](https://circleci.com/gh/Open-MBEE/mdk.svg?style=shield)](https://circleci.com/gh/Open-MBEE/mdk) [![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/Open-MBEE/mdk.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Open-MBEE/mdk/context:java)
 
 Cameo MDK is a plugin for [Cameo Systems Modeler](https://www.nomagic.com/products/cameo-systems-modeler) and other No Magic environment bundles that’s primary purposes are to sync models with the [MMS](https://github.com/Open-MBEE/mms-alfresco) and implement the [DocGen](src/main/dist/manual) language, which allows modelers to dynamically generate documents in a model-based approach using the view and viewpoint concept.
 
@@ -9,12 +9,13 @@ Cameo MDK is a plugin for [Cameo Systems Modeler](https://www.nomagic.com/produc
 ## Prerequisites
 
 * [Cameo Systems Modeler (CSM)](https://www.nomagic.com/products/cameo-systems-modeler) or another No Magic environment bundle that includes the [SysML plugin](https://www.nomagic.com/product-addons/magicdraw-addons/sysml-plugin)
-    * The latest Cameo MDK is tested with and supports **19.0 SP3**. Compatibility for previous versions of Cameo MDK can be found in the [compatibility matrices](https://github.com/Open-MBEE/open-mbee.github.io/wiki/Compatibilities).
-* [Model Management System (MMS) 3](https://github.com/Open-MBEE/mms-alfresco)
+    * The latest Cameo MDK is compatible with **19.0 SP3** and **19.0 SP4**. Compatibility for previous versions of Cameo MDK can be found in the [compatibility matrices](https://github.com/Open-MBEE/open-mbee.github.io/wiki/Compatibilities).
+* [Model Management System (MMS)](https://www.openmbee.org/projects.html#mms)
+    * The latest Cameo MDK is compatible with MMS **4.x**. Compatibility for previous version of Cameo MDK can be found in the [compatibility matrices](https://github.com/Open-MBEE/open-mbee.github.io/wiki/Compatibilities).
 
 ## Installation
 
-1. [Download](https://bintray.com/openmbee/maven/mdk/_latestVersion) the Cameo MDK plugin, e.g. `mdk-*-plugin.zip`.
+1. [Download](https://github.com/Open-MBEE/mdk/releases/latest) the Cameo MDK plugin, e.g. `mdk-*-plugin.zip`.
 
 2. Run CSM. From the main menu, select "Help" > "Resource/Plugin Manager".
    ![Resource/Plugin Manager](doc/images/resource-plugin-manager.png)
@@ -42,7 +43,33 @@ To learn how you can get involved in a variety of ways, please see [Contibuting
 
 Cameo MDK is a Java project that uses the [Gradle](https://gradle.org/) build tool. It can be imported as a Gradle project in IDEs like [IntelliJ](https://www.jetbrains.com/idea/) and [Eclipse](https://www.eclipse.org/ide/).
 
-## Common Tasks
+
+## Custom Build Profiles
+Starting with version 5.0+ you will be able to define custom build profiles (in `./buildProfiles`) which will house 
+the classpath and other variables previously managed by setting `-buildAccess=internal`. These profiles will allow
+customization based on your build process and for your particular version of Cameo. 
+
+**NOTE:** By default build profiles are excluded from being committed to git by a `buildProfiles/.gitignore`
+
+### Create a new profile
+Create a new java properties file in `buildProfiles/<yourProfileName>.properties`.
+In order to use a custom profile to run any of the below commands. Use the command with `-PbuildProfile=<yourProfileName>`
+> For more examples of what properties are available in profiles see the example file in `buildProfiles/example.properties`
+
+### For users of non-standard cameo bundles
+To retrieve the classpath:
+1. Copy the CLASSPATH entry from your `${md.install.dir}/bin/(magicraw/csm/cea).properties` file. 
+2. Paste the entire line into a new file and find replace the `\:` with `,` and set it equal to `classpath`
+3. Save this file to `buildProfiles/<yourProfileName>.properties`
+> This is only necessary for custom build repositories or non-SP3 builds, most users will not need to modify the classpath
+> and modification of the classpath is not necessary to use profiles!
+
+
+
+## Build
+>In order to use a custom profile to run any of the below commands. Use the command with `-PbuildProfile=<yourProfileName>` otherwise it will
+>default to using `opensource`.
+
 * `./gradlew dependencies` will download all necessary dependencies.
 * `./gradlew assemble` will compile Cameo MDK from source.
 * `./gradlew distZip` will package the installable plugin.