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

Different deployment target for test and production #8

Open
lauraporta opened this issue Nov 17, 2022 · 4 comments
Open

Different deployment target for test and production #8

lauraporta opened this issue Nov 17, 2022 · 4 comments
Assignees

Comments

@lauraporta
Copy link
Member

lauraporta commented Nov 17, 2022

Development branches could point to github pages domain (test), and the deploy that comes after merging into main (production) should point to troubleshooting.neuroinformatics.dev
This could be done by reading an environmental variable in in the github actions that triggers the creation of the CNAME file.

@niksirbi niksirbi self-assigned this Nov 17, 2022
@adamltyson
Copy link
Member

Is this possible with GitHub actions? I kinda assumed we could only deploy to one place per repo.

Another option is to see if we can do something similar to the CZI napari plugin preview action and build the docs to deploy somewhere else during a PR.

@adamltyson
Copy link
Member

@neuroinformatics-unit/website-team does anyone know if we can do something like this with the technologies we're currently using? It would be pretty useful.

@niksirbi
Copy link
Member

I think, maybe yes?

Is Sphinx's conf.py we have:

# Redirect the webpage to another URL
# Sphinx will create the appropriate CNAME file in the build directory
# https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html
html_baseurl = 'https://howto.neuroinformatics.dev/'

If we can change this variable or the CNAME file it produces during the website building workflow, it should do the trick. But I may be misunderstanding something fundamental on how websites are deployed.

The other way is to have version-switcher dropdowns, as per this PyData Sphinx Theme guide. If we manage this, we could add a "dev" version in the switcher.

@adamltyson
Copy link
Member

The other way is to have version-switcher dropdowns, as per this PyData Sphinx Theme guide. If we manage this, we could add a "dev" version in the switcher.

Maybe this is the priority for now?

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

No branches or pull requests

3 participants