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

Deploy Pages directly from GitHub action #404

Closed
kolibril13 opened this issue May 31, 2023 · 3 comments
Closed

Deploy Pages directly from GitHub action #404

kolibril13 opened this issue May 31, 2023 · 3 comments
Labels
story Feature request or idea to improve mystjs

Comments

@kolibril13
Copy link
Contributor

Which area is this feature request for?

Other

Describe the feature you'd like to request

The new static export is awesome!
I really like that it's now possible to host myst notebooks on GitHub pages with super low friction, thanks for making this possible!

To make the setup process even more simple one suggestion:
would it be possible to create the GitHub Pages page directly from the Actions artifact without a gh-pages branch?
When there is no gh-pages branch, this would also keep the repo size small.
image

JupyterLite does it that way: https://jupyterlite.readthedocs.io/en/latest/quickstart/deploy.html#generate-a-new-repository-from-the-template
maybe there is a way to bring this also to mystjs

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

@kolibril13 kolibril13 added the story Feature request or idea to improve mystjs label May 31, 2023
rowanc1 added a commit that referenced this issue Jul 3, 2023
rowanc1 added a commit that referenced this issue Jul 3, 2023
* 🏷 Deploy action for GitHub pages

See #404

* 📖 Update deployment documentation.

See #430
@rowanc1
Copy link
Member

rowanc1 commented Jul 3, 2023

This has been updated as the default action in v1.1.0. Note that previous versions of the action will still mostly work, although you will need to rename myst-cli to mystmd. See #451.

To update to the new action:

myst init --gh-pages

And then change your source to GitHub Actions for the pages instead of the branch.

@rowanc1 rowanc1 closed this as completed Jul 3, 2023
@kolibril13
Copy link
Contributor Author

That's amazing, thank you for lowering the barrier to use and share content with myst to such an effortless minimum! :)
I'll try that tomorrow!

@rowanc1
Copy link
Member

rowanc1 commented Jul 3, 2023

It is much better than having the gh-pages branch hanging around!

We have also increased the speed of the CI install by ~17x. 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
story Feature request or idea to improve mystjs
Projects
None yet
Development

No branches or pull requests

2 participants