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: Adds GH action to trigger generate_llmstxt.py, testing action #3047

Open
wants to merge 15 commits into
base: llms-txt
Choose a base branch
from

Conversation

J2-D2-3PO
Copy link
Contributor

@J2-D2-3PO J2-D2-3PO commented Nov 21, 2024

Description

Spawned off of #3045. The goal of this PR is to add a GH action to trigger docs/scripts/generate_llmstxt.py created in #3045 and serve as a testing branch for the new action.

What this PR does:

  • Add .github/workflows/generate-llms.yaml to trigger docs/scripts/generate_llmstxt.py
  • In pyproject.toml, add new entry llmspy = ["PyYAML>=6.0"] in [project.optional-dependencies] for use by hatch in creating env to run script
  • Updates docs/scripts/generate_llmstxt.py with logic to get right directory before calling script
  • Removes llms.txt and llms.md so we can test
  • Makes some sort of change to this branch to check that llms.py is properly triggered
  • Update action logic to work in prod i.e. [on.push.branches]

Testing

  • Locally:
    • In shell, python3 scripts/generate_llmstxt.py -> runs script and generates expected folders in static dir
  • On branch:
    • Initial commits with GH action + deleted llms.txt and llms.py
    • Make any change to the branch and confirm action triggered
    • Confirm that, upon action triggered, expected files generated

@J2-D2-3PO J2-D2-3PO requested a review from a team as a code owner November 21, 2024 21:58
@circle-job-mirror
Copy link

circle-job-mirror bot commented Nov 21, 2024

@J2-D2-3PO J2-D2-3PO marked this pull request as draft November 21, 2024 22:27
@J2-D2-3PO J2-D2-3PO marked this pull request as ready for review November 22, 2024 00:20
@J2-D2-3PO J2-D2-3PO requested a review from scottire November 22, 2024 00:20
@J2-D2-3PO
Copy link
Contributor Author

J2-D2-3PO commented Nov 22, 2024

@scottire this is about 99% ready to go. Commit history is a little confusing, because I was fumbling around with testing for a bit.

Anyways, confirmed that the llms.txt was autogenerated and pushed to this test branch in d39df34.

So I think the remaining todo here is to update the action logic so that it pushes to main. LMk if you think we should add other logic here.

Once that's done, I was thinking we could just squash and merge into your #3045. LMK if that works

@J2-D2-3PO J2-D2-3PO changed the title Adds GH action to trigger generate_llmstxt.py, testing action chore: Adds GH action to trigger generate_llmstxt.py, testing action Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants