gitstream icon indicating copy to clipboard operation
gitstream copied to clipboard

🔧 add .python-version file and update README with Python version requirement for building docs

Open azigler opened this issue 10 months ago • 4 comments

While setting up the dev environment on Python 3.13 (default M2 Python version) I noticed the wheels dependency failed due to versioning support.

I added a file for a user's local pyenv to pick up the correct version for building the docs. I also included a note in the README:

image

✨ PR Description

Purpose and impact: This PR updates the project's Python version requirement and clarifies documentation setup instructions.

Main changes:

  • Specifies Python version 3.10 in new .python-version file
  • Updates README to mention Python version requirement for local documentation setup
  • Removes empty lines for improved readability in README

Generated by LinearB AI and added by gitStream. AI-generated content may contain inaccuracies. Please verify before using. We’d love your feedback! 🚀

azigler avatar Apr 21 '25 19:04 azigler

Please mark which AI tools you used for this PR by checking the appropriate boxes:

  • [ ] GitHub Copilot
  • [x] Cursor
  • [ ] ChatGPT
  • [ ] Tabnine
  • [ ] JetBrains AI Assistant
  • [ ] VSCode IntelliCode
  • [ ] Claude
  • [ ] Gemini
  • [ ] Other AI tool
  • [ ] No AI tools were used

Tip: If you want to avoid this comment in the future, you can add a label of the format 🤖 ai-* when creating your PR.

gitstream-cm[bot] avatar Apr 21 '25 19:04 gitstream-cm[bot]

@PavelLinearB FYI, I'm unable to respond to the microsurvey, it's uneditable for me.

azigler avatar Apr 21 '25 20:04 azigler

@PavelLinearB FYI, I'm unable to respond to the microsurvey, it's uneditable for me.

I think it's because you don't have write permissions to the repo.. We'll fix that

PavelLinearB avatar Apr 22 '25 07:04 PavelLinearB

@PavelLinearB The check_local_links automation is firing but it's a false positive because this is a README. Do we need to change the rule to not label *.md? Let me know how you'd like to fix.

Also, is check_local_links on the gitStream docs? I don't see an example of that there.

azigler avatar Apr 28 '25 22:04 azigler

@PavelLinearB The check_local_links automation is firing but it's a false positive because this is a README. Do we need to change the rule to not label *.md? Let me know how you'd like to fix.

Also, is check_local_links on the gitStream docs? I don't see an example of that there.

@azigler, This automation we added to protect our docs from internal links pointing to localhost, so it should be applied to README files. We should fix it to remove this false positive, and we can add it to our catalog.

PavelLinearB avatar Apr 29 '25 08:04 PavelLinearB

@PavelLinearB In this case, what's triggering the automation was already there (the URL for a user's locally built docs server) and I didn't add it. How do you recommend we point them to their localhost for their docs if we cannot use a local link? I can remove the URL but that feels less helpful.

azigler avatar Apr 29 '25 13:04 azigler

✨ PR Review

LGTM

Generated by LinearB AI and added by gitStream. AI-generated content may contain inaccuracies. Please verify before using. We’d love your feedback! 🚀

gitstream-cm[bot] avatar May 07 '25 17:05 gitstream-cm[bot]

@azigler I have changed the check so it ignore the specific REAME line, see https://github.com/linear-b/gitstream/pull/731

vim-zz avatar May 31 '25 06:05 vim-zz