question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Build documentation PR previews only if files under a path have changed

See original GitHub issue

It would be helpful if we could optionally configure a path to our documentation, and have ReadTheDocs only build previews of the docs if files underneath that path were changed. I’d imagine a configuration box in the Admin panel that was something like

Build PR previews only for changes under folder: docs/

For documentation builds that take a while to build, this would reduce the time for PRs that only change code, but no docs, which is probably quite a lot of PRs! I think that it would also reduce the load on ReadTheDocs build servers, since a documentation change is probably more rare than a code change.

(note: I couldn’t find a “feature request” issue template, which makes me wonder if this is not a good place to open suggestions like this, I am happy to direct this issue elsewhere if that’s better)

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:3
  • Comments:8 (7 by maintainers)

github_iconTop GitHub Comments

2reactions
astrojuanlucommented, Oct 21, 2021

I think we could set reasonable expectations like

  • Tracking the docs/ directory doesn’t mean that the documentation can’t change by other means. This is true for source code docstrings but also dependencies, external data, and possibly other factors.
  • This would only apply for pull request builds, and there would always be a escape hatch to force a build
  • Normal versions wouldn’t have this feature and always build on commit

Does this sound like a useful thing?

1reaction
humitoscommented, Nov 8, 2022

There are different reasons for that. Mainly, I think it was because it was too complex to it right and handle all the edge cases (as @astrojuanlu mentions) and users would be pretty confused.

With the proposed implementation, we are delivering this responsibility to the user itself. The user is responsible to guarantee the check is correct for their own scenario. As it’s using just an exit code from a custom command, it’s pretty flexible to cover most of the use cases and people can write just a simple command or a complex Python script.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Making additional edits on a file after opening a PR
Steps: Viewing your PR in Github, click the “Files Changed” tab. Click the three dots in the top right corner of the editor...
Read more >
Configuring deployment previews | Cloud Run Documentation
Previews allow you to deploy potential changes to a service without changing the live or 'production' version of the service. By deploying a...
Read more >
Deploy Previews | Netlify Docs
Deploy Previews allow you and your team to experience changes to any part of your site without having to publish them to production....
Read more >
Filtering files in a pull request - GitHub Docs
To help you quickly review changes in a large pull request, you can filter changed files or use the file tree to navigate...
Read more >
List all files changed in a pull request in Git/GitHub
In general, you can list the files changed between any two commits with git diff --name-only : How to list only the file...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found