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

chore(repo): cache documentation script #27100

Merged
merged 1 commit into from
Jul 25, 2024
Merged

Conversation

AgentEnder
Copy link
Member

@AgentEnder AgentEnder commented Jul 24, 2024

Current Behavior

documentation is not cacheable. It is reran everytime someone tries to push, including the following flow:

  • git push, fails as docs changes found
  • git commit -am "chore(repo): add docs"
  • git push, runs full docs cycle again in pre-push hook

Expected Behavior

documentation is cacheable, and avoids rerunning when no fs changes are made

Related Issue(s)

Fixes #

Copy link

vercel bot commented Jul 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Updated (UTC)
nx-dev ⬜️ Ignored (Inspect) Visit Preview Jul 24, 2024 10:26pm

@AgentEnder AgentEnder marked this pull request as ready for review July 24, 2024 22:18
@AgentEnder AgentEnder requested a review from a team as a code owner July 24, 2024 22:18
@AgentEnder AgentEnder requested a review from Cammisuli July 24, 2024 22:18
@FrozenPandaz FrozenPandaz merged commit 8f5d3dc into master Jul 25, 2024
6 checks passed
@FrozenPandaz FrozenPandaz deleted the chore/cache-docs branch July 25, 2024 20:52
FrozenPandaz pushed a commit that referenced this pull request Jul 30, 2024
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
`documentation` is not cacheable. It is reran everytime someone tries to
push, including the following flow:

- git push, fails as docs changes found
- git commit -am "chore(repo): add docs"
- git push, runs full docs cycle again in pre-push hook

## Expected Behavior
`documentation` is cacheable, and avoids rerunning when no fs changes
are made

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #

(cherry picked from commit 8f5d3dc)
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants