-
Notifications
You must be signed in to change notification settings - Fork 7
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
Add QoL scripts from Shosetsu Universe #16
Conversation
This looks great! Is there a reason you removed _doc.lua? Thats needed for the IDE to properly suggest and lint types and functions. |
In Shosetsu/Universe, it is downloaded by dev-setup. Since I added that here, having the file in git seemed redundant. |
this ensures indices generated on CRLF systems still contain consistent checksums
I would prefer it be there by default, since I use different ones based on the branch I am on |
this removes the need for rm commands. I also updated the extension tester URL to use a CI-built artifact
Since the MRs this depends on have been merged, this should now be ready for review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you make it so it uses https://jobobby04.github.io/ShosetsuExtensions/master/
instead? I plan to run multiple branches since I also will be adding this to my beta branch.
As far as I can tell, GitHub Pages does not currently support pushing pages only to a subdirectory of the pages root (see this: actions/deploy-pages#349) |
I found this action and it has a subdirectory option which might work https://github.com/marketplace/actions/github-pages-action#%EF%B8%8F-deploy-to-subdirectory-destination_dir |
That actions seems to work by committing the artifacts and, using a personal access token donated by some contributor, pushing to a branch in the repository, from which the artifacts are then published to Pages. Personally, I do not like that approach, but if you prefer it, it should be possible to use for this. |
It sounds like it will fit my use-case better then the other action, so that sounds fine with me. I will create a token to use with this workflow. |
A token has been created at |
Done. I unfortunately cannot test this, but if the action isn't broken it should work. |
Thanks for the work @JFronny! I was able to get it working exactly how I wanted, I have both my beta branch and master branch pushing to the gh-pages branch. I was able to get extension-tester and _doc.lua downloading from the correct places for each branch, it works perfectly. |
This includes Index Generation (which you said you wanted to look into) and, as such, depends on the relevant Shosetsu PRs being merged (this has now happened. Before it did, this used my own extension tester build, which meant this was not ready to be merged)
Specifically, this makes use of a Shosetsu extension tester build with these MRs:
and is a port of this MR: https://gitlab.com/shosetsuorg/extensions/-/merge_requests/526
Like that MR, this uses GitHub Pages (and requires it to be enabled and configured for GitHub Actions).
That said, it also automates index generation, so unless you remove the index from the repo (which is possible, since it is generated from scratch for Pages) existing users shouldn't be affected.