fleet icon indicating copy to clipboard operation
fleet copied to clipboard

Published 20 hours ago • verified publisher icon fleetdm

GitOps: Dry run before merge

Open getvictor opened this issue 1 year ago • 5 comments
trafficstars

Goal

User story
As an endpoint operator using Fleet's best practice GitOps,
I want to run a dry run on every PR I open
so that I can make sure I didn't make any silly typos, etc.

Context

  • Currently, best practice GitOps only runs a dry run after the PR is approved and merged to main. This means the endpoint operator has to merge the PR to see if they made any mistakes.

Changes

Product

  • [ ] GitOps changes: Add a dry run workflow to the best practice GitOps repo (fleetdm/fleet-gitops) that is triggered on pull requests
    • This workflow will run by default for folks that clone the best practice GitOps repo
    • Add this workflow to fleetdm/fleet so that we can dogfood it
  • [ ] Outdated documentation changes: No documentation changes needed.
  • [ ] Changes to paid features or tiers: Available in Fleet Free and Fleet Premium

QA

Risk assessment

  • Requires load testing: TODO
  • Risk level: Low / High TODO
  • Risk description: TODO

Manual testing steps

  1. Step 1
  2. Step 2
  3. Step 3

Testing notes

Confirmation

  1. [ ] Engineer (@____): Added comment to user story confirming successful completion of QA.
  2. [ ] QA (@____): Added comment to user story confirming successful completion of QA.

getvictor avatar Mar 18 '24 14:03 getvictor

Hey @getvictor, heads up, we brought this into the upcoming design sprint (4.49).

When you get the chance, can you please add changes/specs to the "Product" and "Engineering" sections?

noahtalerman avatar Mar 29 '24 14:03 noahtalerman

@noahtalerman I added some details in the Engineering section of this issue.

getvictor avatar Apr 01 '24 17:04 getvictor

Thank @getvictor.

I moved your details to the "Product" section.

I think we want to make the dry run workflow run by default for all GitOps users. I added this.

Since it's the default, and we expect GitOps to work this way, I don't think we need to document it.

noahtalerman avatar Apr 01 '24 18:04 noahtalerman

TODO: After https://github.com/fleetdm/fleet-gitops/pull/36 is merged, I need to update the dogfood workflow.

getvictor avatar May 06 '24 18:05 getvictor

Dry run before merge, No more typos in the cloud, GitOps now refined.

fleet-release avatar May 08 '24 20:05 fleet-release

Dry run before merge, Mistakes caught in gentle light, Fleet's path now more sure.

fleet-release avatar May 30 '24 15:05 fleet-release