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

Add checks for TypeDoc compliance #47

Closed
mcmire opened this issue Feb 8, 2024 · 3 comments
Closed

Add checks for TypeDoc compliance #47

mcmire opened this issue Feb 8, 2024 · 3 comments
Assignees

Comments

@mcmire
Copy link
Collaborator

mcmire commented Feb 8, 2024

We want to make sure that for a given project:

  • The project contains typedoc as a dev dependency, and the versions match the same dev dependencies as in the module template.
  • The project contains a typedoc.json, and the content of this file matches the same as in the module template.
  • The project contains the same build:docs package script as in the module template.
@mcmire
Copy link
Collaborator Author

mcmire commented Feb 8, 2024

Note that there are other TypeDoc-related considerations that we could address in this PR but do not need to:

  • The publish-docs GitHub workflow in the module template uses TypeDoc to generate document and publish it, using the build:docs package script. We want to make sure that projects have this workflow too, but checking this effectively is tricky. We can check that the workflow file is present but how do we know that it's getting run? So we can either think about this either in a separate PR, or we can handle this in Add checks for general module template adherence #6.

@MajorLift
Copy link

MajorLift commented Feb 15, 2024

Stretch: possible starting point for verifying that workflow is running: https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs

@desi
Copy link

desi commented Feb 15, 2024

In this ticket we are not checking the workflow. See Elliot's comment.

@kanthesha kanthesha self-assigned this Feb 19, 2024
kanthesha added a commit that referenced this issue Mar 2, 2024
<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?

Are there any issues or other links reviewers should consult to
understand this pull request better? For instance:

* Fixes #12345
* See: #67890
-->
We want to make sure that for a given project:
* The project contains typedoc as a dev dependency, and the versions
match the same dev dependencies as in the module template.
* The project contains a typedoc.json, and the content of this file
matches the same as in the module template.
* The project contains the same build:docs package script as in the
module template.

Fixes [#47](#47)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants