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 a timeout to Lint (Docs) dep installation #47994

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Oct 28, 2024

For reasons that are unclear, the dependency installation step in the Lint (Docs) GitHub Actions job occasionally takes an indefinite time to complete, and must be canceled manually or after reaching the maximum GitHub Actions runtime.

To prevent this situation, this change adds a timeout of 10 minutes to the step that installs NodeJS dependencies for the Lint (Docs) job. This step tends to take around 7 minutes to complete, so a 10-minute timeout should be reasonable.

For reasons that are unclear, the dependency installation step in the
Lint (Docs) GitHub Actions job occasionally takes an indefinite time to
complete, and must be canceled manually or after reaching the maximum
GitHub Actions runtime.

To prevent this situation, this change adds a timeout of 10 minutes to
the step that installs NodeJS dependencies for the Lint (Docs) job. This
step tends to take around 7 minutes to complete, so a 10-minute timeout
should be reasonable.
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-47994.d3pp5qlev8mo18.amplifyapp.com

@public-teleport-github-review-bot public-teleport-github-review-bot bot removed the request for review from kopiczko October 28, 2024 15:05
@zmb3
Copy link
Collaborator

zmb3 commented Oct 28, 2024

Should we be running the docs lint using an image that already has the right tooling installed instead of spending 7-10 minutes on each run downloading the same stuff?

How often do these dependencies change?

@ptgott
Copy link
Contributor Author

ptgott commented Oct 28, 2024

@zmb3 We used to build a container image from gravitational/docs and pull that. During the time when we used MermaidJS to build SVGs for diagrams, we stopped using the container image because it didn't play well with Chromium, which was required by theMermaid CLI. I am looking into either bringing back the container image or caching node_modules across workflow runs

@ptgott ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Oct 28, 2024
@ptgott ptgott added this pull request to the merge queue Oct 28, 2024
Merged via the queue into master with commit 7f07c40 Oct 28, 2024
42 of 43 checks passed
@ptgott ptgott deleted the paul.gottschling/2024-10-28-timeout branch October 28, 2024 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants