From c371aacb89bcfabe4ce7d23a819c1259ff1dccf2 Mon Sep 17 00:00:00 2001 From: Herman Wika Horn Date: Wed, 23 Nov 2022 08:23:28 +0100 Subject: [PATCH] Update readme so that it contains the correct documentation, and not the documentation that wwas copied from digipost/set-revision --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1143f80..607c258 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# Set Revision javascript action +# Set Maven Goals javascript action -This action uses the github reference of the caller context, -and returns the desired Maven Revision property according to +This action returns the desired Maven Goals property according to our specification. This property is also -exported in the Github Environment as `REVISION`. +exported in the Github Environment as `MVN_GOALS`. Our specification, in short, is as follows: -- Tags remain unchained -- Default branches are renamed to `latest` -- Non-default branches are appended with a `-SNAPSHOT` suffix +- Apps that build and deploy docker images to ACR run jib:build +- Apps that build and deploy JAR packages to GPR run the default `deploy` goal to GPR +- Tests are skipped for tags +- No images or packages are deployed for the default branch ## Inputs @@ -17,19 +17,19 @@ True if the application deploys docker images to Azure Container Registry using ### deploy-to-acr -True if the application deploys JARs to Github Package Registry, otherwise false. +True if the application deploys JARs to Github Package Registry using the default `deploy` goal, otherwise false. ## Outputs -### `revision` +### `maven-goals` -The appropriate `revision` value. -This value is also exported in the Github Environment as `REVISION`. +The appropriate `maven-goals` value. +This value is also exported in the Github Environment as `MVN_GOALS`. ## Example usage ```yaml -uses: digipost/set-revision@v0.7 +uses: digipost/set-maven-goals@v1.0 ``` ## Building this project