{"id":21401159,"url":"https://github.com/uibcdf/action-html-dir-to-gh-pages","last_synced_at":"2026-05-14T22:33:05.079Z","repository":{"id":65162127,"uuid":"539638548","full_name":"uibcdf/action-html-dir-to-gh-pages","owner":"uibcdf","description":"GitHub Action: The gh-pages branch is updated with the content of an html directory to be deployed to GitHub Pages.","archived":false,"fork":false,"pushed_at":"2022-09-21T20:29:52.000Z","size":5,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T03:14:03.189Z","etag":null,"topics":["action","github-actions"],"latest_commit_sha":null,"homepage":"","language":null,"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/uibcdf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-21T18:48:01.000Z","updated_at":"2023-07-28T09:48:01.000Z","dependencies_parsed_at":"2023-01-04T12:39:05.276Z","dependency_job_id":null,"html_url":"https://github.com/uibcdf/action-html-dir-to-gh-pages","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uibcdf%2Faction-html-dir-to-gh-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uibcdf%2Faction-html-dir-to-gh-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uibcdf%2Faction-html-dir-to-gh-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uibcdf%2Faction-html-dir-to-gh-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uibcdf","download_url":"https://codeload.github.com/uibcdf/action-html-dir-to-gh-pages/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243893894,"owners_count":20364919,"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","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":["action","github-actions"],"created_at":"2024-11-22T15:26:24.137Z","updated_at":"2025-11-09T15:06:49.243Z","avatar_url":"https://github.com/uibcdf.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# action-html-dir-to-gh-pages\n[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n\nThe html documentation can be deployed by GitHub Pages by means\nof the 'gh-pages' branch. With this action, the 'gh-pages' branch is automatically updated with the content of a specific directory.\n\nIn summary, this GitHub action does the following:\n\n- Takes the author and SHA id of the trigger action ('push' or 'pull request') to be consistent\n  along the action.\n- Creates a new 'gh-pages' branch if this is not already in the repository.\n- Pushes the html documentation located in a specific directory to the 'gh-pages' branch.\n\nThis GitHub Action was developed by [the Computational Biology and Drug Design Research Unit -UIBCDF- at the\nMexico City Children's Hospital Federico Gómez](https://www.uibcdf.org/). Other GitHub Actions can\nbe found at [the UIBCDF GitHub site](https://github.com/search?q=topic%3Agithub-actions+org%3Auibcdf\u0026type=Repositories).\n\n## How to use it\n\nTo include this GitHub Action, put a Yaml file (named 'html\\_dir\\_to\\_gh\\_pages.yaml', for instance) with the following content in the\ndirectory '.github/workflows' of your repository:\n\n```yaml\nname: HTML dir to gh-pages\n\non:\n  push:\n    branches:\n      - main\n\n# workflow_dispatch:        # Un comment line if you also want to trigger action manually\n\njobs:\n  html_dir_to_gh-pages:\n    runs-on: ubuntu-latest\n    name: HTML dir to gh-pages\n    steps:\n      - uses: actions/checkout@v2\n        with:\n          fetch-depth: 0\n      - name: Running the HTML dir to gh-pages Action\n        uses: uibcdf/action-html-dir-to-gh-pages@v1.0.0\n        with:\n          branch: main\n          html_dir: docs/_build/html\n```\n\n### Input parameters\n\nThese are the input parameters of the action:\n\n| Input parameters | Description | Default value | \n| ---------------- | ------------------------------------------- | ------------------------------------------------------ |\n| branch | Name of the branch where the sphinx documentation is located | 'main' |\n| html\\_dir | Path where the html documentation is | 'docs/\\_build/html' |\n\nThey are placed in the last three lines of the above workflow example file:\n\n```yaml\n      - name: Running the HTML dir to gh-pages Action\n        uses: uibcdf/action-html-dir-to-gh-pages@v1.0.0\n          with:\n            branch: main\n            html_dir: docs/_build/html\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuibcdf%2Faction-html-dir-to-gh-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuibcdf%2Faction-html-dir-to-gh-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuibcdf%2Faction-html-dir-to-gh-pages/lists"}