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

Un-revert docs site changes that broke deployments #373

Open
3 tasks
ptgott opened this issue Aug 14, 2023 · 0 comments
Open
3 tasks

Un-revert docs site changes that broke deployments #373

ptgott opened this issue Aug 14, 2023 · 0 comments

Comments

@ptgott
Copy link
Contributor

ptgott commented Aug 14, 2023

On Aug 14, 2023, we merged two gravitational/docs PRs:

After merging, docs site deployments failed with the following message:

server/rehype-hljs-var.ts(165,42): error TS2345: Argument of type 'MdxJsxFlowElement \| Element' is not assignable to parameter of type 'Content'.
--
13:20:01.677 | Type 'MdxJsxFlowElement' is not assignable to type 'Content'.
13:20:01.677 | Type 'MdxJsxFlowElement' is not assignable to type 'MdxJsxFlowElementHast'.
13:20:01.677 | Types of property 'children' are incompatible.
13:20:01.677 | Type '(BlockContent \| DefinitionContent)[]' is not assignable to type 'ElementContent[]'.
13:20:01.678 | Type 'BlockContent \| DefinitionContent' is not assignable to type 'ElementContent'.
13:20:01.678 | Type 'Code' is not assignable to type 'ElementContent'.
13:20:01.678 | Type 'Code' is not assignable to type 'Raw'.
13:20:01.678 | Types of property 'type' are incompatible.
13:20:01.678 | Type '"code"' is not assignable to type '"raw"'.
13:20:01.719 | error Command failed with exit code 1.

This also affected the docs linter in gravitational/teleport CI workflows.

Let's do this:

  • Investigate the cause of the error and why it evaded CI
  • Find a way to prevent similar errors from slipping past CI in the future
  • Un-revert the two PRs we reverted
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

No branches or pull requests

1 participant