Release tooling about terraform-provider-awscc HOT 1 CLOSED

Update: Release/Registry team has a staging environment however it is public so does not satisfy our requirements; creating a new staging environment would be ideal but the engineering efforts (outside of our team) to do so may not meet our GA timeline as well.

Initial Release Components needed on GA Day:

• Github Milestone for next release -- creation currently manual
• Materials for Publishing to the Registry:
  • Changes Needed in Registry DB:
    • display name and logo e.g. https://github.com/hashicorp/terraform-registry/pull/1335
  • Version Manifest: https://www.terraform.io/docs/plugin/framework/publishing.html
• Github Release -- creation currently triggered by TeamCity config (plan atm is to use the same config used by providers); closing released milestone currently manual

Current Solution for Validating Pre-Release:

• Adopt the TF Provider GithubActions workflow for pre-release and future GA release and beyond

Alt Solution for Validating Pre-Release (not entirely E2E):

-* Make a copy of Terraform Provider Release TC configuration and only enable steps 1-3 (terraform download through compile); steps 4 (release) and 5 (website) will not be validated as we want content to be private

• 👉 This does bring a point to mention that perhaps tf-deploy/hc-releases is not setup to do the following per Publishing to the Registry documentation:

When uploading your new provider version to GitHub, next to the zip files containing your binaries for each platform, include a file named terraform-provider-$NAME_$VERSION_manifest.json (where $NAME is your provider's name, like random and $VERSION is your provider's version, like 1.2.3)...Include the SHA-256 checksum of this JSON file in your SHA256SUMS file.

• ⚠️ Currently there is logic for setting the protocol version, but it does not account for expected manifest file and V6-only support: Adding to the below script can still be validated per TeamCity configuration during testing if the change is merged into tf-deploy
  https://github.com/hashicorp/tf-deploy/blob/21b5687964fbf9a6287ce44b20529f8453696ac2/scripts/init.sh#L217-L237

# Possible addition
  versionManifestPath=$GOPATH/src/github.com/$PROVIDER_ORG/terraform-provider-$PROVIDER_NAME/terraform-provider-${PROVIDER_NAME}_${DEPLOYMENT_TARGET_VERSION}_manifest.json
  if [ -f $versionManifestPath ]; then
    printf "Provider is Protocol 6 only - updating build settings..\n"
    printf "##teamcity[setParameter name='env.PROTOCOL_VERSION' value='6']\n"
    printf "##teamcity[setParameter name='env.PROTOCOL_VERSIONS' value='6.0']"
  fi

• ⚠️ Currently there is logic to create the SHA256SUMS and SHA256SUMS.sig files with the os-specifc archives but this does not include the new manifest file: Adding to the below script will NOT be validated per TeamCity configuration during testing
  https://github.com/hashicorp/tf-deploy/blob/21b5687964fbf9a6287ce44b20529f8453696ac2/scripts/release.sh#L69-L81
  • Since a provider is downloaded with the SHA2456SUMS and SHA256SUMS.sig files I believe we'd have to update the script to include the manifest file but unclear if the manifest file needs to physically exist in https://releases.hashicorp.com/

Additional Findings:

• The TC config defines a DEPLOY_ENV parameters but it's not used in tf-deploy scripts or handed off to hc-releases
• There exist a staging.releases.hashicorp.com for provider artifacts and a https://staging-registry.terraform.io/ (will be replaced byhttps://registry.staging.terraform.io/ soon)both of which are public

from terraform-provider-awscc.