Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

Commit

Permalink
add licenseKey parameter and deprecate proLicenseKey (#31)
Browse files Browse the repository at this point in the history
This adds the licenseKey parameter that we're adding in the work for QCs for databases. As a result, this PR should not be merged or released until after we merge and release the QCs for databases work.
  • Loading branch information
StevenMassaro authored Jun 27, 2022
1 parent 93a18ea commit 384eaf0
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ The `operation` input expects one of the following:

### Optional Inputs

`username`, `password`, `url`, `classpath`, `changeLogFile`, `count`, `tag`, `date`, `referenceUrl`, `proLicenseKey` and `hubApiKey` are optional inputs that may be required by some operations.
`username`, `password`, `url`, `classpath`, `changeLogFile`, `count`, `tag`, `date`, `referenceUrl`, `proLicenseKey` (deprecated in favor of `licenseKey`) and `hubApiKey` are optional inputs that may be required by some operations.

It is recommended that `proLicenseKey` and `hubApiKey` are not stored in plaintext, but rather using a [GitHub secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets):
It is recommended that `licenseKey` and `hubApiKey` are not stored in plaintext, but rather using a [GitHub secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets):

```yaml
proLicenseKey: ${{ secrets.PRO_LICENSE_KEY }}
licenseKey: ${{ secrets.PRO_LICENSE_KEY }}
```

The following operations have the subsequent required inputs:
Expand Down
6 changes: 5 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,14 @@ inputs:
description: 'Configuration file for checks execution'
required: false
proLicenseKey: # string
description: 'Liquibase Pro license key used to unlock paid capabilities'
description: 'DEPRECATED: Liquibase Pro license key used to unlock paid capabilities'
required: false
hubApiKey: # string
description: 'Liquibase Hub API key for operations'
required: false
licenseKey: # string
description: 'Liquibase license key used to unlock paid capabilities'
required: false
databaseChangeLogTableName: # string
description: 'Specifies the Liquibase changelog table'
required: false
Expand All @@ -64,6 +67,7 @@ runs:
- ${{ inputs.checksSettingsFile }}
- ${{ inputs.proLicenseKey }}
- ${{ inputs.hubApiKey }}
- ${{ inputs.licenseKey }}
- ${{ inputs.databaseChangeLogTableName }}
- ${{ inputs.databaseChangeLogLockTableName }}
branding:
Expand Down
6 changes: 4 additions & 2 deletions entry.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ REFERENCEURL=${10}
CHECKSSETTINGSFILE=${11}
PROLICENSEKEY=${12}
HUBAPIKEY=${13}
DATABASECHANGELOGTABLENAME=${14}
DATABASECHANGELOGLOCKTABLENAME=${15}
LICENSEKEY=${14}
DATABASECHANGELOGTABLENAME=${15}
DATABASECHANGELOGLOCKTABLENAME=${16}

PARAMS=()
VALUES=()
Expand Down Expand Up @@ -205,6 +206,7 @@ function validate_operation() {

check_optional_param "$OPERATION" proLicenseKey $PROLICENSEKEY
check_optional_param "$OPERATION" hubApiKey $HUBAPIKEY
check_optional_param "$OPERATION" licenseKey $LICENSEKEY
validate_operation

docker-entrypoint.sh "${PARAMS[@]}" $OPERATION "${VALUES[@]}" "${SECONDPARAMS[@]}"

0 comments on commit 384eaf0

Please sign in to comment.