-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme so that it contains the correct documentation, and not …
…the documentation that wwas copied from digipost/set-revision
- Loading branch information
Showing
1 changed file
with
12 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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-[email protected] | ||
uses: digipost/set-[email protected] | ||
``` | ||
## Building this project | ||
|