{"id":16130997,"url":"https://github.com/davids/jekyll-deploy","last_synced_at":"2025-03-18T14:31:10.010Z","repository":{"id":43330982,"uuid":"238214764","full_name":"DavidS/jekyll-deploy","owner":"DavidS","description":"Builds and deploys a jekyll page to GitHub pages","archived":false,"fork":false,"pushed_at":"2023-01-23T23:01:33.000Z","size":141,"stargazers_count":10,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-13T10:38:42.362Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DavidS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-04T13:38:42.000Z","updated_at":"2023-09-28T18:56:53.000Z","dependencies_parsed_at":"2023-02-13T17:45:40.638Z","dependency_job_id":null,"html_url":"https://github.com/DavidS/jekyll-deploy","commit_stats":{"total_commits":38,"total_committers":4,"mean_commits":9.5,"dds":"0.26315789473684215","last_synced_commit":"efb6045733158a09af0a86d5bb730ae8f594929a"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidS%2Fjekyll-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidS%2Fjekyll-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidS%2Fjekyll-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidS%2Fjekyll-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DavidS","download_url":"https://codeload.github.com/DavidS/jekyll-deploy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243933420,"owners_count":20370986,"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":[],"created_at":"2024-10-09T22:18:57.117Z","updated_at":"2025-03-18T14:31:09.752Z","avatar_url":"https://github.com/DavidS.png","language":"Ruby","readme":"# jekyll-deploy\n\nBuilds and deploys a jekyll page to GitHub pages.\n\nFeatures:\n* build and test modes\n* record the site's source commit using a merge commit\n* build from any subdirectory in your repository\n* specify a target branch\n\n## Usage\n\nTo deploy every update to the `main` branch and regenerate the site once a day:\n\n```yaml\nname: Jekyll Deploy\n\non:\n  push:\n    branches:\n      # deploy on updates on main\n      - main\n  schedule:\n    # redeploy every morning to update unpublished pages\n    - cron: \"0 2 * * *\"\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v2\n\n      - name: Cache gems\n        uses: actions/cache@v1\n        with:\n          path: vendor/gems\n          key: ${{ runner.os }}-build-${{ hashFiles('**/Gemfile.lock') }}\n          restore-keys: |\n            ${{ runner.os }}-build-\n            ${{ runner.os }}-\n\n      - name: Build \u0026 Deploy to GitHub Pages\n        uses: DavidS/jekyll-deploy@main\n        env:\n          JEKYLL_ENV: production\n          GH_PAGES_TOKEN: ${{ secrets.GH_PAGES_TOKEN }}\n```\n\nTo check PRs, set `build-only: true`:\n\n```yaml\nname: Jekyll Test\n\non: [ pull_request ]\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v2\n\n      - name: Cache gems\n        uses: actions/cache@v1\n        with:\n          path: vendor/gems\n          key: ${{ runner.os }}-build-${{ hashFiles('**/Gemfile.lock') }}\n          restore-keys: |\n            ${{ runner.os }}-build-\n            ${{ runner.os }}-\n\n      - name: Test\n        uses: DavidS/jekyll-deploy@\n        with:\n          build-only: true\n        env:\n          JEKYLL_ENV: production\n          GH_PAGES_TOKEN: ${{ secrets.GH_PAGES_TOKEN }}\n```\n\nThe `GH_PAGES_TOKEN` needs the `public_repo` scope to be able to trigger deployments on a public repo or the full `repo` scope to deploy a private repository. Please note that this is circumventing GitHub's protection for infinitely recursive Actions invocations, so proceed with caution!\n\n## Specifying a source directory\n\nIf your site's source is not at the root of the repository, you can use the `source-dir` input to tell this action where the source can be found. For example, if your site is in a `docs/jekyll` subdirectory:\n\n```yaml\n      - name: Build \u0026 Deploy to custom branch\n        uses: DavidS/jekyll-deploy@\n        with:\n          source-dir: docs/jekyll\n        env:\n          JEKYLL_ENV: production\n          GH_PAGES_TOKEN: ${{ secrets.GH_PAGES_TOKEN }}\n```\n\n\n## Specifying a target branch\n\nBy default, this action deploys the compiled output to `gh-pages`, GitHub's default. If you want to use a different branch, you can use the `target-branch` input to do so. For example, to deploy to `docs`:\n\n```yaml\n      - name: Build \u0026 Deploy to custom branch\n        uses: DavidS/jekyll-deploy@main\n        with:\n          target-branch: docs\n        env:\n          JEKYLL_ENV: production\n          GH_PAGES_TOKEN: ${{ secrets.GH_PAGES_TOKEN }}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavids%2Fjekyll-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavids%2Fjekyll-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavids%2Fjekyll-deploy/lists"}