Add unit testing #17
Comments
|
We can also consider adding the Storybook tests from |
ptgott
added a commit
that referenced
this issue
Jan 29, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. To simplify things, use a single tsconfig.json for Jest as well as plugins. To get the `remark-includes` test to pass, edit the `updatePaths` function to only extract a version number from the path of a partial if the partial falls under a directory path for production content.
ptgott
added a commit
that referenced
this issue
Jan 29, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. To get the `remark-includes` test to pass, edit the `updatePaths` function to only extract a version number from the path of a partial if the partial falls under a directory path for production content.
ptgott
added a commit
that referenced
this issue
Jan 29, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. To get the `remark-includes` test to pass, edit the `updatePaths` function to only extract a version number from the path of a partial if the partial falls under a directory path for production content.
ptgott
added a commit
that referenced
this issue
Jan 30, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. This change does not add tests for `remark-includes`, which requires some changes to how the site processes link paths.
ptgott
added a commit
that referenced
this issue
Jan 30, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. This change does not add tests for `remark-includes`, which requires some changes to how the site processes link paths.
ptgott
added a commit
that referenced
this issue
Jan 30, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. This change does not add tests for `remark-includes`, which requires some changes to how the site processes link paths.
ptgott
added a commit
that referenced
this issue
Jan 30, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. This change does not add tests for `remark-includes`, which requires some changes to how the site processes link paths.
ptgott
added a commit
that referenced
this issue
Jan 30, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. This change does not add tests for `remark-includes`, which requires some changes to how the site processes link paths.
ptgott
added a commit
that referenced
this issue
Jan 31, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. This change does not add tests for `remark-includes`, which requires some changes to how the site processes link paths.
ptgott
added a commit
that referenced
this issue
Jan 31, 2025
See #17 Migrate unit tests for our custom remark and rehype plugins from the archived `gravitational/docs` repo. Convert these tests to Jest, which unlike the uvu testing tool we used for `gravitational/docs`, is still being maintained. Add a GitHub Actions workflow to run the tests on pull requests. This change does not add tests for `remark-includes`, which requires some changes to how the site processes link paths.
|
I am going to close this issue since we now have a unit test suite for server code. It's looking to be non-trivial to move our Storybook tests to Docusaurus, since there's no Storybook framework/addon that (a) supports Docusaurus's built-in webpack config and (b) is currently being maintained. I think we can cover that and any end-to-end testing needs in a separate issue if we want. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The legacy docs engine includes a unit test suite, which it runs using the following command:
There hasn't been any development on loadr or uvu in a few years, so we should switch to an industry standard like Jest.
I propose we:
gravitational/docsdocs-websiteThe text was updated successfully, but these errors were encountered: