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

bug: stencil test with e2e trigger documentation build #5950

Closed
3 tasks done
Sukaato opened this issue Aug 19, 2024 · 2 comments · Fixed by #5951
Closed
3 tasks done

bug: stencil test with e2e trigger documentation build #5950

Sukaato opened this issue Aug 19, 2024 · 2 comments · Fixed by #5951
Labels
Bug: Validated This PR or Issue is verified to be a bug within Stencil

Comments

@Sukaato
Copy link
Contributor

Sukaato commented Aug 19, 2024

Prerequisites

Stencil Version

4.20.0

Current Behavior

When running stencil test --e2e --spec, stencil have to make a build for the e2e part, and this trigger generate the custom documentation, and generate the documentation should not be part of the testing phase.

Expected Behavior

do not generate the custom documentation

System Info

System: node 20.16.0
    Platform: linux (5.15.153.1-microsoft-standard-WSL2)
   CPU Model: AMD Ryzen 7 5700X 8-Core Processor (16 cpus)
    Compiler: /home/sukaato/projects/poppy-ui/node_modules/@stencil/core/compiler/stencil.js
       Build: 1722623140
     Stencil: 4.20.0 🚐
  TypeScript: 5.5.3
      Rollup: 2.56.3
      Parse5: 7.1.2
      jQuery: 4.0.0-pre
      Terser: 5.31.1

Steps to Reproduce

  1. Create component and generate the docs and commit
  2. Update the component jsdocs so i can be highlighted on the next commit
  3. run npm test hould be by default stencil test --e2e --spec)*
  4. See the readme has been updated

Code Reproduction URL

https://github.com/Sukaato/stencil-test-generate-docs

Additional Information

Should add a condition here: https://github.com/ionic-team/stencil/blob/main/src/compiler/output-targets/output-custom.ts#L7

Since outputCustom can generate more that a readme documentation, i think the flag config.buildDocs should be not used, maybe the config._isTesting can be used

@ionitron-bot ionitron-bot bot added the triage label Aug 19, 2024
@christian-bromann christian-bromann added Bug: Validated This PR or Issue is verified to be a bug within Stencil and removed triage labels Aug 19, 2024
@christian-bromann
Copy link
Member

Thanks for reporting @Sukaato. I ingested the bug into our backlog but I want to set the expectations straight: we can't tell you when we will be able to tackle the issue. If you are blocked on it, we recommend to take a stab and provide a bug fix, the Stencil team is happy to provide guidance on that. Thanks!

Sukaato added a commit to Sukaato/stencil that referenced this issue Aug 19, 2024
Do not generate custom output target on test

fixes: ionic-team#5950
Sukaato added a commit to Sukaato/stencil that referenced this issue Aug 27, 2024
Do not generate custom output target on test

fixes: ionic-team#5950
github-merge-queue bot pushed a commit that referenced this issue Aug 30, 2024
Do not generate custom output target on test

fixes: #5950
@christian-bromann
Copy link
Member

A fix for this has been released in Stencil v4.22.0 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug: Validated This PR or Issue is verified to be a bug within Stencil
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants