Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ARCH-2088 - +semver:breaking Changes for TechHub deployments #267

Merged
merged 1 commit into from
Jun 14, 2024

Conversation

danielle-casella-adams
Copy link
Contributor

@danielle-casella-adams danielle-casella-adams commented Jun 13, 2024

Changes for TechHub Deployments

Changes in im-reusable-finish-deployment-workflow.yml

  • These inputs that were optional before are now required
    • deploy-notifications-channel
      • Replaces the old secrets.DEPLOY_NOTIFICATIONS_CHANNEL. This change was made because the value is not a secret, it is a variable defined at the org level
    • instance
      • Similar to the previous target-slot input and used to identify the target deployment location
      • Generally some combination of deployment-environment, slot-name and AZ region values.
      • e.g., primary, primary-app-service, testing-slot, failover-slot-2, NA26, NA27-production-slot.
    • entity
      • The TechHub (catalog-info.yml) entity that is being deployed
      • This is how TechHub knows what entity to show the deployments on
  • These items have been removed because they were only utilized by update-deployment-board
    • inputs.source-slot
    • inputs.target-slot
    • inputs.slot-swapped-with-production-slot
    • inputs.enable-deployment-slot-tracking
    • inputs.deployable-label
    • inputs.deployable-type
    • inputs.deployment-board-number
  • This was replaced in favor of an input
    • secrets.DEPLOY_NOTIFICATIONS_CHANNEL
      • use the inputs.deploy-notifications-channel instead

Changes in Workflow Templates

  • Updated to use the latest version of each reusable workflow (@V3)
  • repository-projects: write and issues: write were removed
  • deployments: write was previously added to each of these workflows
  • The deprecated inputs were removed
  • The inputs that are now required were uncommented

To update to this latest version and migrate to TechHub deployments teams should follow the changes that were done to the workflow templates above. create-github-deployment does rely on a catalog-info.yml entity. If one doesn't exist, you'll need to add it for the deployments to show up in TechHub.

- Remove deprecated inputs from the reusable finish deployment workflow
- Make techhub deployment related inputs required in the finish deployment workflow
- Update workflow templates to use latest reusable workflow versions (@V3) & modify inputs accordingly
- Update permissions in each of the "deploy" templates now that deployment-board permissions are no longer needed
@danielle-casella-adams danielle-casella-adams requested a review from a team as a code owner June 13, 2024 20:21
@@ -67,6 +66,7 @@ jobs:
working-directory: '${{ env.TF_WORKING_DIR }}'

steps:
# TODO: SWAT - Need a replacement for determining which release is the latest
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just a heads up, I left a TODO here because I think it's kind of an involved fix. I looked at the way IFP did it and it seems like this could be simplified. I'd like to work on a more streamlined solution before updating this file. Maybe part of that is investigating whether this template is providing the value we want.

Copy link
Contributor

@hpractv hpractv left a comment

Choose a reason for hiding this comment

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

👍🏽

@danielle-casella-adams danielle-casella-adams merged commit ba7b565 into main Jun 14, 2024
@danielle-casella-adams danielle-casella-adams deleted the techhub-deployments branch June 14, 2024 14:52
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.

2 participants