Gitpod is a container-based dev platform that provisions ready-to-code environments in the cloud accessible through your browser.
Steps to run gitpod and explore the Nextflow training gitpod.
-
Install gitpod app: https://github.com/apps/gitpod-io/installations/new
-
Check out a github repo, by going to your github main page appending https://gitpod.io/# to your https://github.com/<github_username>/ Here gitpod will open an enviroment with all the files from within your git repo (this is like a git clone into the cloud).
You can also initiate a gitpod env from github, once you have installed the app (step 1). Then you can find this button in your github:
- Try opening the Nextflow training gitpod and check out its yml!
For Nextflow training check out : https://gitpod.io/#https://github.com/chriswyatt1/Gitpod_test/
- Nextflow is installed and the tutorial data downloaded within the task commands of the .gitpod.yml.
The .gitpod.yml in the main git repo folder is the main config file to add software, download programs etc.
# List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/
tasks:
- name: Download Nextflow Tutorial
init: |
echo 'init script' # runs during prebuild
echo 'start script'
curl -s https://get.nextflow.io | bash
mkdir /workspace/bin
cp ./nextflow /workspace/bin/nextflow
export PATH=/workspace/bin:$PATH
nextflow info
command: echo 'Now Nextflow an the tutorial data are loaded'
In the above yml: init means prebuild scripts to run (such as downloading databases etc). command execute once the workspace is open. In the above example I change some folders and permissions in the workspace.
- Configure a prebuild. To enable prebuilt workspaces for a GitHub repository, follow these steps:
- Go to the Gitpod GitHub app and click Configure
- Choose the organization or account you wish to install the Gitpod app for, then click Install
- You will be forwarded to Gitpod where you can confirm the installation
This will enable the prebuild so that when you open the gitpod again in this repo, it will load faster from the prebuild.
- Add a interactive web env for webpage (see in gitpod.yml)
# List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/
tasks:
- name: Web serverer
command: npx browser-sync start -s -w --index Example.html --port 8000
- To enable conda use:
conda_activate
For the tutorial, we will add these lines:
== Using Gitpod (Coming soon)
Use a preconfigured Nexflow development environment using Gitpod.
Requirements:
- GitHub, GitLab or BitBucket account
- Web browser (Google Chrome, Firefox)
Future Steps:
- Link to Seqera Training landing page.
- Open the link recieved in your email.
- Proceed with Nextflow tutorial.