{"id":14070538,"url":"https://github.com/dzsquared/jupyter-publish-action","last_synced_at":"2025-07-30T08:30:55.283Z","repository":{"id":37796043,"uuid":"304971241","full_name":"dzsquared/jupyter-publish-action","owner":"dzsquared","description":"GitHub action for publishing a remote Jupyter book for Azure Data Studio 📘","archived":true,"fork":false,"pushed_at":"2023-01-03T17:03:26.000Z","size":4543,"stargazers_count":5,"open_issues_count":6,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-04T12:41:15.450Z","etag":null,"topics":["azure-data-studio","hacktoberfest","jupyter-book"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/remote-jupyter-book-publish","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dzsquared.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-17T21:20:41.000Z","updated_at":"2023-01-09T00:12:03.000Z","dependencies_parsed_at":"2023-01-04T12:15:08.439Z","dependency_job_id":null,"html_url":"https://github.com/dzsquared/jupyter-publish-action","commit_stats":{"total_commits":31,"total_committers":2,"mean_commits":15.5,"dds":"0.032258064516129004","last_synced_commit":"0e4e94a908b97e3e151278f16dc628432710fb9c"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/dzsquared/jupyter-publish-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dzsquared%2Fjupyter-publish-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dzsquared%2Fjupyter-publish-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dzsquared%2Fjupyter-publish-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dzsquared%2Fjupyter-publish-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dzsquared","download_url":"https://codeload.github.com/dzsquared/jupyter-publish-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dzsquared%2Fjupyter-publish-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267835395,"owners_count":24151758,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azure-data-studio","hacktoberfest","jupyter-book"],"created_at":"2024-08-13T07:07:50.808Z","updated_at":"2025-07-30T08:30:54.385Z","avatar_url":"https://github.com/dzsquared.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# 📘 Create a Remote Jupyter Book Release\n\nUse this action to create a GitHub release for your Jupyter book, quickly making it accessible as a remote Jupyter book in Azure Data Studio.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/actions/typescript-action/actions\"\u003e\u003cimg alt=\"typescript-action status\" src=\"https://github.com/actions/typescript-action/workflows/build-test/badge.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n## 🚄 Usage Guide\n\n### Manual Start from Workflow Form\nIn its simplest form, this action can be manually triggered in the browser on the Actions tab for a repository.\n\n![workflow form with inputs](/images/workflowForm.png)\n\nTo setup the workflow for a manual trigger, create a new GitHub Action workflow and replace the workflow with the following:\n\n```yml\n# This is a basic workflow that is manually triggered\nname: Remote Jupyter Book\n\n# Controls when the action will run. Workflow runs when manually triggered using the UI\non:\n  workflow_dispatch:\n    # Inputs the workflow accepts.\n    inputs:\n      directory:\n        description: 'Jupyter Book to Release (defaults to whole repository)'\n        default: '.'\n        required: true\n      releasename:\n        description: 'Release name'\n        required: true\n      bookname:\n        description: 'Book name'\n        required: true\n      versionnumber:\n        description: 'Version number'\n        required: true\n      languageid:\n        description: 'Language id'\n        default: 'EN'\n        required: true\n\n# A workflow run is made up of one or more jobs that can run sequentially or in parallel\njobs:\n  RemoteBook:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout code\n        uses: actions/checkout@v2\n      - name: Publish book\n        uses: dzsquared/jupyter-publish-action@v0.1.0\n        with:\n          directory: ${{ github.event.inputs.directory }}\n          releasename:  ${{ github.event.inputs.releasename }}\n          bookname: ${{ github.event.inputs.bookname }}\n          versionnumber: ${{ github.event.inputs.versionnumber }}\n          languageid: ${{ github.event.inputs.languageid }}\n          githubtoken: ${{ secrets.GITHUB_TOKEN }}\n\n```\n\n### Other Workflows\n\nThe 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!\n\n\n## 🛠 Inputs\n\n### `directory`\nThis 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.\n\n### Azure Data Studio fields\n![Azure Data Studio remote book dialog](images/remoteBook.png)\n- `releasename` = Releases\n- `bookname` = Book\n- `versionnumber` = Version\n- `languageid` = Language\n\n\n### `githubtoken`\nThis 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 }}`.\n\n## 🧪 Sample\nThere's a live sample of this action at https://github.com/dzsquared/sample-notebooks.\n\n## ⚖ License\nThis project is licensed under the [MIT license](https://github.com/dzsquared/jupyter-publish-action/blob/main/LICENSE).\n\n## 🧩 Contributing\nThis is a small project without any technical contribution guidelines.  All contributors must abide by the [Contributor Covenant Code of Conduct](./CONTRIBUTING.md).\n\n## ⏳ Release Notes\n### v0.1.0\nFirst preview release.\n\n### v0.0.1-0.0.23\nTesting and developing in the open.  It was messy, but it got us here.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdzsquared%2Fjupyter-publish-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdzsquared%2Fjupyter-publish-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdzsquared%2Fjupyter-publish-action/lists"}