Use this action to create a GitHub release for your Jupyter book, quickly making it accessible as a remote Jupyter book in Azure Data Studio.

In its simplest form, this action can be manually triggered in the browser on the Actions tab for a repository.

To setup the workflow for a manual trigger, create a new GitHub Action workflow and replace the workflow with the following:

# This is a basic workflow that is manually triggered
name: Remote Jupyter Book

# Controls when the action will run. Workflow runs when manually triggered using the UI
on:
  workflow_dispatch:
    # Inputs the workflow accepts.
    inputs:
      directory:
        description: 'Jupyter Book to Release (defaults to whole repository)'
        default: '.'
        required: true
      releasename:
        description: 'Release name'
        required: true
      bookname:
        description: 'Book name'
        required: true
      versionnumber:
        description: 'Version number'
        required: true
      languageid:
        description: 'Language id'
        default: 'EN'
        required: true

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  RemoteBook:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Publish book
        uses: dzsquared/[email protected]
        with:
          directory: ${{ github.event.inputs.directory }}
          releasename:  ${{ github.event.inputs.releasename }}
          bookname: ${{ github.event.inputs.bookname }}
          versionnumber: ${{ github.event.inputs.versionnumber }}
          languageid: ${{ github.event.inputs.languageid }}
          githubtoken: ${{ secrets.GITHUB_TOKEN }}

The action can be used with other triggers, provided that the inputs are obtained or statically set. I'd love to hear how this is used, please feel free to open an issue to share your scenario!

This input defaults to ., or the root of the repository. If the folders for the Jupyter book, such as content and _data, are nested within the repository, change this value to their location. Changing this value is not a typical scenario for a repository with a single Jupyter book.

• releasename = Releases
• bookname = Book
• versionnumber = Version
• languageid = Language

This is a token specific to the repository and the action runtime. You do not need to generate a token or do anything but put the value ${{ secrets.GITHUB_TOKEN }}.

There's a live sample of this action at https://github.com/dzsquared/sample-notebooks.

This project is licensed under the MIT license.

This is a small project without any technical contribution guidelines. All contributors must abide by the Contributor Covenant Code of Conduct.

First preview release.

Testing and developing in the open. It was messy, but it got us here.