docs: update readme with current tech stack and github actions badge#66
Conversation
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://green-water-08792290f-66.eastus2.2.azurestaticapps.net |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
chrisjwalk-bot
force-pushed
the
docs/update-readme
branch
from
9e010d8 to
38757d9
Compare
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://green-water-08792290f-66.eastus2.2.azurestaticapps.net |
chrisjwalk-bot
left a comment
chrisjwalk-bot
left a comment
There was a problem hiding this comment.
Good catch! The postinstall script runs update-readme, so pnpm install auto-regenerates README.md from two source files:
docs/github-readme.md— just the CI badge (GitHub-only)apps/web-app/src/assets/home.md— the shared content (also rendered on the app home page)
Nothing was lost — the new content is intentional. The old README had an Azure DevOps badge that no longer works, VS2022/VS Code sections, and no mention of the actual stack.
That said, the two-file setup is confusing. A simpler approach: make README.md the single source of truth and have the postinstall script derive home.md from it (stripping the badge). That way there's only one file to edit and the app home page stays in sync.
Should I flip the direction — edit README.md directly, generate home.md from it?
- README.md is now the single source of truth (edit this directly) - update-readme target now generates home.md by stripping the badge line - Remove docs/github-readme.md (no longer needed) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
If you flip it, the problem still remains that we have to remember to do a |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://green-water-08792290f-66.eastus2.2.azurestaticapps.net |
chrisjwalk
left a comment
chrisjwalk
left a comment
There was a problem hiding this comment.
Can we also add some info about the built in features for the app? Like the DX stuff, notification center, auth flow, etc.
It's also still not clear here how README.md is the single source of truth and how/when home.md get's generated from that
- Add .lintstagedrc.cjs with function syntax to run update-readme whenever README.md is committed, then auto-stage home.md - Move lint-staged config out of package.json (functions require .cjs) - Remove update-readme from postinstall (no longer needed there) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Good point! Fixed in the latest commit. Added a Also removed |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://green-water-08792290f-66.eastus2.2.azurestaticapps.net |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://green-water-08792290f-66.eastus2.2.azurestaticapps.net |
Uses irongut/CodeCoverageSummary to parse cobertura XMLs and: - Write a coverage table + badge to the GitHub Actions job summary - Post a sticky PR comment with the coverage report Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://green-water-08792290f-66.eastus2.2.azurestaticapps.net |
|
The code coverage report is only showing the app, we need all of the tests (and should fix the missing coverage on the app). |
- Add debug.spec.ts covering all 6 add methods, clearAll, and markAllRead - Change CI test step to always run test:all so coverage report includes all libs, not just affected projects Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://green-water-08792290f-66.eastus2.2.azurestaticapps.net |
…sts in CI
- Revert CI test step to nx affected (only test:all on main push)
- Add annotation to coverage PR comment noting it's affected-only
- Add vitest perFile coverage thresholds (80% all metrics) to catch
new code added without tests
- Exclude *.routes.ts, *.config.ts, main.ts, environments from coverage
- Fix coverage gaps to meet thresholds:
- notification.store: add markRead multi-notification test (covers
ternary else branch)
- notification-list: add read-state and iconFor fallback tests
- notification-bell: add singular aria-label, handset branch,
overlay toggle-close, and re-open tests
- counter.store: add inputCount and event dispatch tests (covers
reducer callbacks via withCounterReducer)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://green-water-08792290f-66.eastus2.2.azurestaticapps.net |
|
Note Coverage shown for affected projects only. Per-file thresholds (80%) are enforced by vitest.
|
2 participants
Closes #67
Changes
The
README.mdis generated bypnpm nx run web-app:update-readmefromdocs/github-readme.md+apps/web-app/src/assets/home.md.