fides icon indicating copy to clipboard operation
fides copied to clipboard

ENG-648: Prevent manual updates to autogenerated Fides.js docs

Open tvandort opened this issue 10 months ago • 1 comments

Closes ENG-648

Description Of Changes

Prevent merging if autogenerated docs were manually updated.

Code Changes

  • list your code changes here

Steps to Confirm

  1. list any manual steps for reviewers to confirm the changes

Pre-Merge Checklist

  • [ ] Issue requirements met
  • [ ] All CI pipelines succeeded
  • [ ] CHANGELOG.md updated
    • [ ] Add a https://github.com/ethyca/fides/labels/db-migration label to the entry if your change includes a DB migration
    • [ ] Add a https://github.com/ethyca/fides/labels/high-risk label to the entry if your change includes a high-risk change (i.e. potential for performance impact or unexpected regression) that should be flagged
    • [ ] Updates unreleased work already in Changelog, no new entry necessary
  • Followup issues:
    • [ ] Followup issues created
    • [ ] No followup issues
  • Database migrations:
    • [ ] Ensure that your downrev is up to date with the latest revision on main
    • [ ] Ensure that your downgrade() migration is correct and works
      • [ ] If a downgrade migration is not possible for this change, please call this out in the PR description!
    • [ ] No migrations
  • Documentation:
    • [ ] Documentation complete, PR opened in fidesdocs
    • [ ] Documentation issue created in fidesdocs
    • [ ] If there are any new client scopes created as part of the pull request, remember to update public-facing documentation that references our scope registry
    • [ ] No documentation updates required

tvandort avatar May 27 '25 21:05 tvandort

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
fides-plus-nightly ⬜️ Ignored (Inspect) Visit Preview Jul 18, 2025 9:43pm
fides-privacy-center ⬜️ Ignored (Inspect) Jul 18, 2025 9:43pm

vercel[bot] avatar May 27 '25 21:05 vercel[bot]

fides    Run #13139

Run Properties:  status check passed Passed #13139  •  git commit 26672ea771: ENG-648: Prevent manual updates to autogenerated Fides.js docs (#6175)
Project fides
Branch Review main
Run status status check passed Passed #13139
Run duration 00m 50s
Commit git commit 26672ea771: ENG-648: Prevent manual updates to autogenerated Fides.js docs (#6175)
Committer Tom Van Dort
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 5
View all changes introduced in this branch ↗︎

cypress[bot] avatar Jul 18 '25 22:07 cypress[bot]