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

chore: automate-docs #513

Merged
merged 5 commits into from
Dec 14, 2024
Merged

chore: automate-docs #513

merged 5 commits into from
Dec 14, 2024

Conversation

ryanbas21
Copy link
Contributor

fix doc generation commands

JIRA Ticket

Please link jira ticket here

Description

Type of Change

Please Delete options that are not relevant

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Definition of Done

Check all that apply

  • Acceptance criteria is met.
  • All tasks listed in the user story have been completed.
  • Coded to standards.
  • Code peer-reviewed.
  • Ensure backward compatibility (special attention).
  • API reference docs is updated.
  • Unit tests are written.
  • Integration tests are written.
  • e2e tests are written.
  • CI build passing on the feature branch.
  • Functional spec is written/updated
  • contains example code snippets.
  • Change log updated.
  • Documentation story is created and tracked.
  • UI is completed or ticket is created.
  • Demo to PO and team.
  • Tech debts and remaining tasks are tracked in separated ticket(s).

Documentation

  • Acceptance criteria met
  • Spell-check run
  • Peer reviewed
  • Proofread

Copy link

changeset-bot bot commented Dec 10, 2024

⚠️ No Changeset found

Latest commit: 4d0b4f5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

nx-cloud bot commented Dec 10, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 4d0b4f5. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

fix doc generation commands
@ryanbas21 ryanbas21 force-pushed the docs-generation branch 2 times, most recently from 809a900 to fc8fd76 Compare December 12, 2024 17:28
@codecov-commenter
Copy link

codecov-commenter commented Dec 12, 2024

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Please upload report for BASE (develop@ef5c2fa). Learn more about missing BASE report.

Files with missing lines Patch % Lines
packages/device-client/src/lib/device.store.ts 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             develop     #513   +/-   ##
==========================================
  Coverage           ?   57.24%           
==========================================
  Files              ?      123           
  Lines              ?    26966           
  Branches           ?     1717           
==========================================
  Hits               ?    15438           
  Misses             ?    11528           
  Partials           ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ryanbas21 ryanbas21 force-pushed the docs-generation branch 3 times, most recently from 1ccdc30 to d99bb5c Compare December 12, 2024 18:37
Copy link
Contributor

@spetrov spetrov left a comment

Choose a reason for hiding this comment

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

LGTM!

add codecov, fix up tsconfigs, and add extenssions to mock-api-v2 for
node16+ support
@@ -92,3 +92,8 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_CONFIG_PROVENANCE: true

- uses: codecov/codecov-action@v5
Copy link
Contributor Author

Choose a reason for hiding this comment

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

after we publish everything, we can try to upload a coverage report. doing this after because by this point we should have

A) run tests, and builds
B) I don't want uploading coverage to affect the publish or versioning, etc

@@ -69,9 +69,6 @@
"{projectRoot}/{options.coverage.reportsDirectory}",
"{workspaceRoot}/coverage/e2e/mock-api-v2"
],
"options": {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

i've defined this all in the vite config.

import { PingOneCustomHtmlResponseBody } from '../schemas/custom-html-template/custom-html-template-response.schema';
import { SuccessResponseRedirect } from '../schemas/return-success-response-redirect.schema';
} from '../schemas/authorize.schema.js';
import { PingOneCustomHtmlResponseBody } from '../schemas/custom-html-template/custom-html-template-response.schema.js';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

updating tsconfigs made this a change, its all just adding extensions to files.

coverage: {
reportsDirectory: '../../coverage/e2e/token-vault-interceptor',
reportsDirectory: './coverage',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

keeping all directories local to the package it was from

@@ -18,7 +18,9 @@
}
},
"docs": {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

adding doc building to the pipeline.

This also runs tsc it seems. Basically if we "successfully build" docs in the CI we can choose to upload them somewhere in the future.

Also just gives us a check against all the types of tools we are useing, make sure it works in a fresh env.

@ryanbas21 ryanbas21 merged commit 26f6855 into develop Dec 14, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

4 participants