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(release): fix docs steps for release #5303

Merged
merged 1 commit into from
Jan 29, 2024

Conversation

rwaskiewicz
Copy link
Contributor

@rwaskiewicz rwaskiewicz commented Jan 29, 2024

What is the current behavior?

see 'new behavior'
GitHub Issue Number: N/A

What is the new behavior?

fix the indentation on documentation release steps so that the render properly in a rich markdown viewer. github's markdown renderer does not see the steps beginning with 'Merge any open PRs' and 'If the current release' as children of the doc site step, causing them to be rendered as follow up steps:

2. Navigate to the Stencil Site repo and:
3. Merge any open PRs...
4. If the current release...

Documentation

N/A - fixes local documentation for releasing stencil

Does this introduce a breaking change?

  • Yes
  • No

Testing

Before (at 89816e1):
Screenshot 2024-01-29 at 11 16 34 AM

After (apply this commit):
Screenshot 2024-01-29 at 11 17 18 AM

Other information

fix the indentation on documentation release steps so that the render
properly in a rich markdown viewer. github's markdown renderer does
not see the steps beginning with 'Merge any open PRs' and 'If the
current release' as children of the doc site step, causing them to be
rendered as follow up steps:
```md
2. Navigate to the Stencil Site repo and:
3. Merge any open PRs...
4. If the current release...
```
Copy link
Contributor

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1207 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files
Path Error Count
src/dev-server/index.ts 37
src/mock-doc/serialize-node.ts 36
src/dev-server/server-process.ts 32
src/compiler/prerender/prerender-main.ts 22
src/testing/puppeteer/puppeteer-element.ts 22
src/runtime/client-hydrate.ts 20
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 17
src/compiler/config/test/validate-paths.spec.ts 16
src/dev-server/request-handler.ts 15
src/compiler/prerender/prerender-optimize.ts 14
src/compiler/sys/stencil-sys.ts 14
src/compiler/transpile/transpile-module.ts 14
src/sys/node/node-sys.ts 14
src/compiler/prerender/prerender-queue.ts 13
src/compiler/sys/in-memory-fs.ts 13
src/runtime/connected-callback.ts 13
src/runtime/set-value.ts 13
src/compiler/output-targets/output-www.ts 12
src/compiler/transformers/test/parse-vdom.spec.ts 12
Our most common errors
Typescript Error Code Count
TS2345 366
TS2322 362
TS18048 224
TS18047 99
TS2722 37
TS2532 26
TS2531 23
TS2454 14
TS2790 11
TS2352 10
TS2769 8
TS2538 8
TS2344 6
TS2416 6
TS2493 3
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 14 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports
File Line Identifier
src/runtime/bootstrap-lazy.ts 21 setNonce
src/screenshot/screenshot-fs.ts 18 readScreenshotData
src/testing/testing-utils.ts 198 withSilentWarn
src/utils/index.ts 145 CUSTOM
src/utils/index.ts 269 normalize
src/utils/index.ts 7 escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 115 Env
src/compiler/app-core/app-data.ts 117 NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts 123 updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts 61 satisfies
src/compiler/types/validate-primary-package-output-target.ts 61 Record
src/testing/puppeteer/puppeteer-declarations.ts 485 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

@rwaskiewicz rwaskiewicz marked this pull request as ready for review January 29, 2024 16:17
@rwaskiewicz rwaskiewicz requested a review from a team as a code owner January 29, 2024 16:17
@rwaskiewicz rwaskiewicz added this pull request to the merge queue Jan 29, 2024
Merged via the queue into main with commit 97138a4 Jan 29, 2024
120 checks passed
@rwaskiewicz rwaskiewicz deleted the rwaskiewicz/fix-release-readme branch January 29, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants