Releases: Cox-Automotive/alks-cli
v3.15.0
Change Log Items
- Alks developer configure no longer collects userID unless basic auth selected
Description
Adds some hints around the network username field. Also changes developer configure to only get the userid id if basic auth is selected
Rally: US1118087: ALKS CLI: Validate Network Username
v3.14.0
Description
We didn't have this work planned but I've been wanting to do this for some time now. This adds support for passing aliases anywhere that you can pass an account ID or account string. For example, before when calling alks sessions open you could pass the -a/--account and -r/--role and the value of the account field could be any of these options:
- 012345678910
- 012345678910/ALKSAdmin
- 012345678910/ALKSAdmin - awstest
but now you can also pass just the alias (awstest), so you don't have to memorize account IDs anymore. To do this I added a function that looks up account info based on whatever you passed to get the account ID, alias, and label from ALKS. This added an extra call to get all accounts that a user has via the getAlksAccounts function, which slowed performance, so I added some very short-lived caching to that function call to speed things up since it was getting called multiple times per command
Rally # US852948: ALKS CLI - Accept alias in place of account ID
How has this been tested?
More unit tests were added to cover just about all the code that I touched, and I spent a while testing the commands manually to ensure that they still functioned correctly
v3.13.1
v3.13.0
v3.12.2
v3.12.1
Description
Adds log statements for printing the secrets obtained from the command line or keystore, but only when the --unsafe-verbose flag is passed. Otherwise it just prints the length of the secret and the first character. The intent of this extra logging is to help users be able to debug the CLI themselves and they should never be instructed to share the output of running any command with the --unsafe-verbose flag. I expect to be able to use this to help debug user issues by asking them to run commands with this flag without sharing the output and instead just asking them to confirm that the value shown is the one they pasted from their clipboard/copied from ALKS Web/expected to see
Type of change
- Patch (non-breaking change which fixes an issue)
v3.12.0
v3.11.1
v3.11.0
Description
Adds a tags option to the createtrustrole cli function. The format for the tags input can be either JSON or a shorthand syntax (different from the shorthand for other function inputs) and is handled by the unpackTags utility function. a Tags object is created and passed to alks.createNonServiceRole
Rally # US805882: ALKS CLI - Support tagging for createtrustrole command
Type of change
- Feature (non-breaking change which adds functionality)
How has this been tested?
Unit tests were added to capture most conceivable input cases forunpackTags.
Steps:
- npm test
Checklist / To Do:
v3.10.0
Description
Adds a tags option to the createrole cli function. The format for the tags input can be either JSON or a shorthand syntax (different from the shorthand for other function inputs) and is handles by the unpackTags utility function. a Tags object is created and passed to alks.createRole
Rally # US805874
Type of change
- Feature (non-breaking change which adds functionality)
How has this been tested?
Unit tests were added to capture most conceivable input cases forunpackTags.
*Note* I think the ts type system change involving unknown types not falling under the any umbrella is surfacing in the 'errorAndExit` code. I'll try to find more information later.
Steps:
- npm test
Checklist / To Do:
- Write documentation reflecting the change
- find more info on the uknown types and mitigate any issues
- implement errorAndExit in unpackTags