figure out a better deploy strategy

[ctb]

snakemake deploy --use-conda autodeploys to https://nih-cfde.github.io/use-case-library-build/ using mkdocs gh-deploy, documented here - https://www.mkdocs.org/user-guide/deploying-your-docs/

this is a bit too easy 😄 - both amanda and I have accidentally deployed the site a few times now!

what's a better workflow? how do we enable previews? these questions must be asked.

maybe the solution is to figure out a readthedocs thing? difficult given the build step here.

[ACharbonneau]

I know that charles had some checks in place, i feel like we had branch protection and uncle archie was doing previews somehow

[ctb]

On Mon, Nov 09, 2020 at 06:51:50AM -0800, Amanda Charbonneau wrote:

I know that charles had some checks in place, i feel like we had branch protection and uncle archie was doing previews somehow

right, but I don't think we want to write/run our own CI system without a Charles... we could easily set up another GH repo to do previews, and have that be the default target - should we do that? Or do you have other thoughts?

--t

[ACharbonneau]

I was thinking something like rendering in a second repo, I just didn't want to say it out loud :)

That would solve the issue of online previews, but I'm not sure how to solve the branch protection thing. One needs to deploy from local, but if i protect gh-pages, it won't accept the deployment. We'd have to change deployment to be to a different branch on the main repo, and then do PRs to gh-pages I think

So, all together we'd need:

• a second repo, that just exists to preview things, where everyone on the team has push access to gh-pages
• to write up a tutorial about how to push changes from one repo to another
• to write a new snakemake function that deploys to a dev branch on the main repo
• make periodic PRs from dev to gh-pages

[ctb]

On Mon, Nov 09, 2020 at 04:28:07PM -0800, Amanda Charbonneau wrote:

I was thinking something like rendering in a second repo, I just didn't want to say it out loud :)

:) github repos are cheap.

That would solve the issue of online previews, but I'm not sure how to solve the branch protection thing. One needs to deploy from local, but if i protect gh-pages, it won't accept the deployment. We'd have to change deployment to be to a different branch on the main repo, and then do PRs to gh-pages I think

OR, how about github actions that WHEN something gets merged into a particular branch, like 'release' or 'stable', it gets deployed to the official site; and otherwise it just gets deployed to preview?

[ACharbonneau]

that sounds like a thing that someone could probably make a robot do. I don't think I'll have time this week tho, so it would be good if someone could sacrifice themselves volunteer

[s-canchi]

This GH action seems promising. I can tinker with this and test it out.

[marisalim]

what is the workflow for deploying this website? can anyone deploy it? @ctb (asking generally, but also for #61)

[ACharbonneau]

I can deploy, or Titus.

[marisalim]

ok, @ACharbonneau or @ctb please deploy :) and then we can see if the analytics are working

[ctb]

On Wed, Mar 31, 2021 at 02:50:22PM -0700, Marisa Lim wrote:

ok, @ACharbonneau or @ctb please deploy :) and then we can see if the analytics are working

I ran:

snakemake --use-conda deploy -j 1

on the latest branch - did that work?

[ctb]

the main thing I wanted to make sure of was that the conda environment used by snakemake had pinned versions.