GitHub Workflow Deployment

In Deploy Settings we defined the deployment branch in the .github/workflows/deploy.yml file, which is used by the workflow, whenever performing git push.

You are free to use any branch, other than the gh-pages, keeping in mind that only upon the git push, the workflow will be triggered.

The workflow deployment itself is tracked by your repository’s status indicator, in this case a beige-brown dot  ⏺

• Clicking on it will show the running status, and the deployment details.

As mentioned, the deployment takes minutes to finish, depending on the content files, i.e. the python commands in the Jupyter Notebooks. These will take up the most of the required deployment time.

Deployment status upon git push to the branch specified in the deploy.yml file

Upon the deployment finalization, the status indicator turns to:

• successful: a green thick 🗸

  • you should be able to see the changes taking place, after some moments, at the specified https://<your-username>.github.io/data-science-for-esm[1]

• unsuccessful: a red cross mark 🗶

  • indicating an error in the _toc.yml, or one of the content files, which need to be revisited.

Successful deployment, after a finalized jupyter-book build run

---

[1]

executablebooks/cookiecutter-jupyter-book