Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update distribution note in readme #52

Merged
merged 1 commit into from
Nov 30, 2022
Merged

docs: update distribution note in readme #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,33 @@ The tool supports two type of authentication methods -
1. Basic Anypoint Platform Credentials
2. Anypoint [Connected App Credentials](https://help.mulesoft.com/s/article/How-to-deploy-an-application-to-CloudHub-using-Connected-App-functionality)

# Distribution

Starting v1.2.0, The Maven Plugin and Core library is published to [Maven Central](https://repo1.maven.org/maven2/com/avioconsulting/mule/). To **use released versions** from maven central, you do not need any credential or pluginRepository declaration. Just add mule-deploy-maven-plugin configuration to your project and you are good to go.


## Snapshots
Starting v1.2.0, SNAPSHOTs are build from `master` branch and are published to [Sonatype Snapshot Repository](https://oss.sonatype.org/content/repositories/snapshots/com/avioconsulting/mule/).

To use snapshot versions, you would need to add following in your pom.xml -

```xml
<pluginRepositories>
<!-- Your any existing plugin repositories can stay in the pom and add a new one shown below -->
<pluginRepository>
<id>oss.sonatype.org-snapshot</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
```


# Maven plugin

NOTE: The Maven plugin has 2 goals (deploy and validate). Regardless of whether you use it to actually perform the deployment, it's highly recommended you use the validate goal to ensure your DSL file is correct during the build pipeline.
Expand Down Expand Up @@ -42,7 +69,7 @@ If you have no strong preference, then stick with the "with POM" approach which
<plugin>
<groupId>com.avioconsulting.mule</groupId>
<artifactId>mule-deploy-maven-plugin</artifactId>
<version>1.0.0</version>
<version>${mule-deploy-maven-plugin.version}</version>
<executions>
<execution>
<id>do_validation</id>
Expand Down