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

Revert GHA Tugboat integration #17007

Merged
merged 4 commits into from
Feb 2, 2024
Merged

Revert GHA Tugboat integration #17007

merged 4 commits into from
Feb 2, 2024

Conversation

JunTaoLuo
Copy link
Contributor

@JunTaoLuo JunTaoLuo commented Jan 24, 2024

Description

Resolves #16884. This will revert the changes from #16279 #16562 and #16739. These changes will return to using webhook integration for Tugboat previews.

Testing done

Webhooks tested using the following steps with a test PR.

QA steps

Testing this change requires turning on the Tugboat webhook which will be disruptive since duplicate Tugboat previews will be created. When testing make an announcement in the CMS channel so other developers are aware of the issue and clean up duplicated previews once testing is done. To test this change, make a PR that targets this branch and perform the following actions which tests for routine PR actions including opening, updating, closing, reopening and merging.

As any user who can open PRs on this repo

  1. Turn on Tugboat webhooks in the repository settings and enable sending PR notifications
    • Navigate to Settings >> Webhooks >> https://dev.va.gov/cms-tugboat/... >> Edit
    • Under "Which events would you like to trigger this webhook?" choose "Let me select individual events."
    • Check "Pull requests" and do not uncheck "Pushes"
    • Click "Update Webhook"
  2. Open a PR targeting this branch 16884-revert. I recommend making a small documentation change that can be reverted in step 6.
    • Ensure required CI workflows are triggered and completes successfully
    • Ensure Tugboat deployments are triggered and the status and links are posted to the PR. E.g.
image image
  • Ensure previews are created and can be accessed
  1. Update the PR with an new commit
    • Ensure required CI workflows are triggered and completes successfully
    • Ensure previews are rebuilt on PR updates, ensure the SHA of the commit used to build the preview is the updated commit.
    • Ensure previews are created and can be accessed
  2. Close the PR without merging
    • Ensure Tugboat deployments status is updated (i.e. deployment is destroyed). E.g:
image
  • Ensure previews are deleted
  1. Re-open the PR
    • Ensure required CI workflows are triggered and completes successfully
    • Ensure Tugboat deployments are triggered and the status and links are posted to the PR
    • Ensure previews are created and can be accessed
  2. Merge the PR to this branch
    • Ensure Tugboat deployments status is updated (i.e. deployment is destroyed)
    • Ensure previews are deleted
  3. Clean up changes made during these tests
  • Revert the the changes contained in the PR so it does not affect this PR functionally.
  • Turn off the Tugboat PR webhook
  • Review Tugboat previews and delete any duplicates created during testing

Definition of Done

  • Documentation has been updated, if applicable.
  • Tests have been added if necessary.
  • Automated tests have passed.
  • Code Quality Tests have passed.
  • Acceptance Criteria in related issue are met.
  • Manual Code Review Approved.
  • If there are field changes, front end output has been thoroughly checked.

Select Team for PR review

  • CMS Team
  • Public websites
  • Facilities
  • User support
  • Accelerated Publishing

@github-actions github-actions bot added the CMS Team CMS Product team that manages both editor exp and devops label Jan 24, 2024
@va-cms-bot va-cms-bot temporarily deployed to Tugboat February 1, 2024 05:11 Destroyed
@JunTaoLuo JunTaoLuo marked this pull request as ready for review February 1, 2024 05:30
@JunTaoLuo JunTaoLuo requested review from a team as code owners February 1, 2024 05:30
@ndouglas
Copy link
Contributor

ndouglas commented Feb 2, 2024

Given the disruptiveness of testing these changes and the fact that we know we had a working system under the prior model just a few weeks ago, I'm inclined to just do a code-level review on this. Thoughts?

Copy link
Contributor

@ndouglas ndouglas left a comment

Choose a reason for hiding this comment

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

Seems legit; I have no notes.

@JunTaoLuo
Copy link
Contributor Author

Given the disruptiveness of testing these changes and the fact that we know we had a working system under the prior model just a few weeks ago, I'm inclined to just do a code-level review on this. Thoughts?

Yea I think that is fine, especially since I did test the webhooks after hours two days ago.

Copy link

github-actions bot commented Feb 2, 2024

GitHub Workflows (.github/workflows/*.yml)

Have you...

  • pinned all affected GitHub Actions at a specific commit by SHA?
  • reviewed the source code of the action at the commit you are pinning?
  • confirmed that no GitHub security measures are being bypassed?
  • checked for any injection of user content into protected contexts?
  • reviewed Security hardening for GitHub Actions?
  • reviewed GitHub Workflows?

@va-cms-bot va-cms-bot temporarily deployed to Tugboat February 2, 2024 15:27 Destroyed
@JunTaoLuo JunTaoLuo merged commit e785254 into main Feb 2, 2024
18 checks passed
@JunTaoLuo JunTaoLuo deleted the 16884-revert branch February 2, 2024 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CMS Team CMS Product team that manages both editor exp and devops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Investigate frequent failures of the Delete Tugboat Preview workflow
3 participants