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

Create a deploy action #85

Merged
merged 19 commits into from
Oct 30, 2024

Conversation

pbarbarant
Copy link
Collaborator

@pbarbarant pbarbarant commented Jul 15, 2024

Updates various gh actions and implements automatic deployment of the docs on a gh-pages branch.

@bthirion
Copy link
Contributor

DO we need to merge in order to see if it works ?
@emdupre any comment ?

@pbarbarant
Copy link
Collaborator Author

DO we need to merge in order to see if it works ? @emdupre any comment ?

Yes in order to see the website, however we can check beforehand that the action completed successfully.

with:
name: doc
name: DocHTML
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to be explicit about the format as sphinx can compile to various forms + it's consistent with other repos in Parietal-INRIA / mind-inria.

.github/workflows/doc-build.yml Outdated Show resolved Hide resolved
@pbarbarant
Copy link
Collaborator Author

Refactored the doc-build.yml with @emdupre to simplify the overall workflow. The website is now deployed from the gh-pages branch and will be automatically updated with every merge/push to the mainbranch.
BTW artifacts are also kept.

@emdupre
Copy link
Collaborator

emdupre commented Oct 30, 2024

Thanks, @pbarbarant ! When checks are green I'm good to merge 🚀

I already set up the redirect from https://parietal-inria.github.io/fmralign-docs and archived that repo, so I think this should be the end of our deployment issues ! 🎉

Copy link
Contributor

@bthirion bthirion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks mostly good. Need to wait for CI to complete.

.github/workflows/doc-build.yml Outdated Show resolved Hide resolved
@pbarbarant
Copy link
Collaborator Author

Closes #91

@emdupre
Copy link
Collaborator

emdupre commented Oct 30, 2024

This is now the same error we saw before merging in 7dbab07 , so I think it's ready to go and I'm happy to see this in !

@pbarbarant
Copy link
Collaborator Author

Okay I'm merging it!

@pbarbarant pbarbarant merged commit 3a7917f into Parietal-INRIA:main Oct 30, 2024
4 of 5 checks passed
@pbarbarant pbarbarant deleted the docs/deploy-to-gh-pages branch October 31, 2024 15:02
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.

3 participants