Use the GHA base container for Lint (Docs)#25173
Merged
Conversation
This way, we can take advantage of the software the comes pre-installed on the GHA `ubuntu-latest` container image. Otherwise, we need to find a way to portably install Chromium on the `gravitational/docs` container in order to run the Mermaid CLI. Currently, the docs engine exits with an error during the "Lint (Docs)" job when attempting to build mermaid diagrams due to not being able to locate Chromium. For this change to work, the "Lint (Docs)" job checks out `gravitational/docs`, removes the default git submodule configuration, then adds a git submodule for the current `gravitational/teleport` branch. From there, it can install dependencies via `yarn` and run our CI scripts.
ptgott
requested review from
klizhentas,
r0mant,
russjones and
zmb3
as code owners
avatus
approved these changes
Apr 26, 2023
Merged
zmb3
approved these changes
Apr 28, 2023
public-teleport-github-review-bot
Bot
removed the request for review
from jimbishopp
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Contributor
Author
|
This PR was removed from the merge queue because (ironically) this job failed (https://github.com/gravitational/teleport/actions/runs/4834250893/jobs/8615249557), so I am going to convert this back into a draft while I investigate. |
Contributor
Author
|
Looks like the command below failed because ...so the error is: Should we change the |
avatus
approved these changes
May 3, 2023
public-teleport-github-review-bot
Bot
removed the request for review
from jimbishopp
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
ptgott
force-pushed
the
paul.gottschling/2023-04-25-lint-docs-ubuntu
branch
from
4b9d7e2 to
9ed3f5b
Compare
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
ptgott
force-pushed
the
paul.gottschling/2023-04-25-lint-docs-ubuntu
branch
from
9ed3f5b to
9e8669c
Compare
This was referenced May 5, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This way, we can take advantage of the software the comes pre-installed on the GHA
ubuntu-latestcontainer image. Otherwise, we need to find a way to portably install Chromium on thegravitational/docscontainer in order to run the Mermaid CLI. Currently, the docs engine exits with an error during the "Lint (Docs)" job when attempting to build mermaid diagrams due to not being able to locate Chromium.For this change to work, the "Lint (Docs)" job checks out
gravitational/docs, removes the default git submodule configuration, then adds a git submodule for the currentgravitational/teleportbranch. From there, it can install dependencies viayarnand run our CI scripts.Reviewer note: Here is a successful
Lint (Docs)run: https://github.com/gravitational/teleport/actions/runs/4768585354/jobs/8478204853