Skip to content

require release type in utility scripts - #132

Open
amcmanus wants to merge 2 commits into
mainfrom
adam/add-release-type-to-utility-scripts
Open

require release type in utility scripts#132
amcmanus wants to merge 2 commits into
mainfrom
adam/add-release-type-to-utility-scripts

Conversation

@amcmanus

Copy link
Copy Markdown
Contributor

This is an initial solution to a feature request that would use release type asset directories for vx-iso rather than using a shared directory that is overwritten each time. This enables installing different release types without having to extract the image each time you switch between release types.

While this adds some level of convenience, it adds to the complexity of the local user environment when managing different releases. For example, a user could extract a field release with the admin release type. That would put a valid field release under the admin assets directory structure. If an older field release were still present, it's possible that release could then be installed instead of the most recently extracted. Similarly, a user could intend to install an admin release, not realizing a field release was most recently extracted there by mistake.

@arsalansufi, I don't want to over-rotate on this, but I'd be interested in whether you think there's value in taking the time and effort to consider something like embedding the release type in a release to help with some of this basic validation? There's probably a follow-up question on whether we should add another check for the release version for many of the same reasons.

@arsalansufi arsalansufi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super delayed review but better late than never

Comment thread live-build/extract-build-assets.sh Outdated
#!/bin/bash

vxiso_tarball=$1
RELEASE_TYPE=${2:-"field"}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm so I don't think that we should default the value to field. Because then, if you forget to specify the second param but are extracting an admin vx-iso image, you're gonna persist it at the wrong location silently. I think that the second param should always be explicitly specified. I'm happy with this approach if we drop the default/fallback value.

@amcmanus amcmanus self-assigned this Aug 31, 2026
@amcmanus
amcmanus marked this pull request as ready for review August 31, 2026 15:13
@amcmanus

Copy link
Copy Markdown
Contributor Author

This will close votingworks/vxsuite#7197

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

vx-iso should name build assets based on the release type and install based on release type

2 participants