Skip to content

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

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.

Sign up for GitHub

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

Draft
wants to merge 6 commits into
base: ENG-651
Choose a base branch
from
Draft

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c2f2ac1
task: change npm i to npm ci in pipelines.
tvandort May 27, 2025
2b5a999
Fail if docs are different.
tvandort May 15, 2025
a8d11d8
Check for matrix.
tvandort May 15, 2025
a5095c1
Working dir.
tvandort May 15, 2025
8386d31
Bad commit!
tvandort May 15, 2025
a2c6a0e
Remove failure test.
tvandort May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/cypress_admin-ui.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ jobs:
node-version: 20.x

- name: Install dependencies
run: npm install
run: npm ci

- name: Build FidesJS
working-directory: clients/fides-js
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cypress_e2e.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
- name: Install dependencies
run: |
cd clients/cypress-e2e
npm install
npm ci

- name: Cypress E2E tests
uses: cypress-io/github-action@v6
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cypress_privacy-center.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
node-version: 20.x

- name: Install dependencies
run: npm install
run: npm ci

- name: Build FidesJS
working-directory: clients/fides-js
Expand Down
18 changes: 17 additions & 1 deletion .github/workflows/frontend_checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,23 @@ jobs:
node-version: ${{ matrix.node-version }}

- name: Install dependencies
run: npm install
run: npm ci

- name: Generate docs
if: matrix.clients == 'fides-js'
working-directory: clients/fides-js
run: npm run docs:generate

- name: Fail if docs are not up to date
if: matrix.clients == 'fides-js'
working-directory: clients/fides-js
run: |
if [[ -n "$(git status --porcelain)" ]]; then
echo "Docs are not up to date. Please run 'npm run docs:generate' and commit the changes.";
git status
git diff
exit 1
fi

- name: Lint
run: npm run lint
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish_package.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
- name: Install node modules
run: |
cd clients
npm install
npm ci

- name: Build and export frontend files
run: |
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ COPY clients/fides-js/package.json ./fides-js/package.json
COPY clients/admin-ui/package.json ./admin-ui/package.json
COPY clients/privacy-center/package.json ./privacy-center/package.json

RUN npm install
RUN npm ci

COPY clients/ .

Expand Down