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

Simplify Lint (Docs) #48845

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Nov 12, 2024

Currently, Lint (Docs) configures git submodules for gravitational/teleport within a gravitational/docs clone based on the value of $GITHUB_REF or $GITHUB_HEAD_REF so it can fetch the submodules and build the docs.

This change checks out gravitational/teleport using actions/checkout instead, then copies the teleport clone into the content directory of the docs clone. This way, we don't need to extract a branch name, and can perform multiple checks on the teleport clone, e.g., the Vale linter when we add it to Lint (Docs).

Copy link

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

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

@ptgott ptgott force-pushed the paul.gottschling/2024-11-12-no-submodules branch from 5c23cd4 to 637602f Compare November 12, 2024 20:51
Currently, `Lint (Docs)` configures git submodules for
`gravitational/teleport` within a `gravitational/docs` clone based on
the value of `$GITHUB_REF` or `$GITHUB_HEAD_REF` so it can fetch the
submodules and build the docs.

This change checks out `gravitational/teleport` using `actions/checkout`
instead, then copies the `teleport` clone into the `content` directory
of the `docs` clone. This way, we don't need to extract a branch name,
and can perform multiple checks on the `teleport` clone, e.g., the Vale
linter when we add it to `Lint (Docs)`.
@ptgott ptgott force-pushed the paul.gottschling/2024-11-12-no-submodules branch from 637602f to 9c5cb89 Compare November 12, 2024 21:01
@ptgott ptgott marked this pull request as ready for review November 12, 2024 21:10
@ptgott ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Nov 13, 2024
@ptgott
Copy link
Contributor Author

ptgott commented Nov 13, 2024

@mmcallister Checking to see if this looks okay to you. Thanks!

@ptgott ptgott added this pull request to the merge queue Nov 14, 2024
Merged via the queue into master with commit e24c2ef Nov 14, 2024
43 of 44 checks passed
@ptgott ptgott deleted the paul.gottschling/2024-11-12-no-submodules branch November 14, 2024 15:12
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.

3 participants