{"id":13622098,"url":"https://github.com/actions/jekyll-build-pages","last_synced_at":"2025-05-16T09:02:42.662Z","repository":{"id":37052598,"uuid":"438323626","full_name":"actions/jekyll-build-pages","owner":"actions","description":"A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages.","archived":false,"fork":false,"pushed_at":"2025-01-20T12:59:49.000Z","size":880,"stargazers_count":95,"open_issues_count":8,"forks_count":42,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-05-14T04:08:10.615Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pages.github.com","language":"HTML","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/actions.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-14T16:28:35.000Z","updated_at":"2025-04-28T08:51:17.000Z","dependencies_parsed_at":"2024-05-02T03:57:43.282Z","dependency_job_id":"63d29566-cc43-4f3c-92cb-15436a16a341","html_url":"https://github.com/actions/jekyll-build-pages","commit_stats":{"total_commits":129,"total_committers":14,"mean_commits":9.214285714285714,"dds":0.7209302325581395,"last_synced_commit":"c2d3f388e1c98cd181c6371f87c58e0a3313e693"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fjekyll-build-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fjekyll-build-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fjekyll-build-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fjekyll-build-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actions","download_url":"https://codeload.github.com/actions/jekyll-build-pages/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254447647,"owners_count":22072753,"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-08-01T21:01:14.046Z","updated_at":"2025-05-16T09:02:42.642Z","avatar_url":"https://github.com/actions.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# jekyll-build-pages\n\nA simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages.\n\n## Scope\n\nThis is used along with [`actions/deploy-pages`](https://github.com/actions/deploy-pages) as part of the official support for building Pages with Actions (currently in public beta for public repositories).\n\n## Usage\n\nA basic Pages deployment workflow with the `jekyll-build-pages` action looks like this.\n\n```yaml\nname: Build Jekyll site\non:\n push:\n   branches: [\"main\"]\npermissions:\n  contents: read\n  pages: write\n  id-token: write\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n      - name: Setup Pages\n        uses: actions/configure-pages@v5\n      - name: Build\n        uses: actions/jekyll-build-pages@v1\n      - name: Upload artifact\n        uses: actions/upload-pages-artifact@v3\n  deploy:\n    runs-on: ubuntu-latest\n    needs: build\n    steps:\n      - name: Deploy to GitHub Pages\n        id: deployment\n        uses: actions/deploy-pages@v4\n    environment:\n      name: github-pages\n      url: ${{ steps.deployment.outputs.page_url }}\n```\n\nTo write to a different destination directory, match the inputs of both the `jekyll-build-pages` and [`upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) actions.\n\n```yaml\nsteps:\n  - name: Build\n    uses: actions/jekyll-build-pages@v1\n    with:\n      destination: \"./output\"\n  - name: Upload artifact\n    uses: actions/upload-pages-artifact@v3\n    with:\n      path: \"./output\"\n```\n\n### Action inputs\n\n| Input | Default | Description |\n|-------|---------|-------------|\n| `source` | `./` | The directory to build from |\n| `destination` | `./_site` | The directory to write output into\u003cbr\u003e(this should match the `path` input of the [`actions/upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) action) |\n| `future` | `false` | If `true`, writes content dated in the future |\n| `build_revision` | `$GITHUB_SHA` | The SHA-1 of the Git commit for which the build is running |\n| `verbose` | `false` | If `true`, prints verbose output in logs |\n| `token` | `$GITHUB_TOKEN` | The GitHub token used to authenticate API requests |\n\n## Release instructions\n\nIn order to release a new version of this Action:\n\n1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]).\n\n2. Prepare a pull request to update [`action.yml`][action.yml] to reference the incoming version, get it approved, and merge it into the `main` branch.\n\n3. Publish the draft release **as a pre-release** from the `main` branch with semantic version as the tag name, _with_:\n   - the checkbox to publish to the GitHub Marketplace checked :ballot_box_with_check:\n   - :warning: _AND_ the checkbox to **Set as a pre-release** checked. :ballot_box_with_check:\n\n4. This will kick off a [Docker publishing workflow][docker-publish] for the newly created tag. Check the [associated workflow run list][docker-publish-workflow-runs] to verify the new Docker image is created successfully before moving on to the next step.\n\n5. After the Docker image has been created with the new tag, find that [same pre-release][release-list] and edit it. Update it with the checkbox to **Set as the latest release** checked :ballot_box_with_check: and then publish it again.\n\n6. After publishing it as the latest release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v1`.\n\n   ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE).\n\n\u003c!-- references --\u003e\n[release-list]: https://github.com/actions/jekyll-build-pages/releases\n[draft-release]: .github/workflows/draft-release.yml\n[docker-publish]: .github/workflows/docker-publish.yml\n[release]: .github/workflows/release.yml\n[docker-publish-workflow-runs]: https://github.com/actions/jekyll-build-pages/actions/workflows/docker-publish.yml\n[release-workflow-runs]: https://github.com/actions/jekyll-build-pages/actions/workflows/release.yml\n[action.yml]: https://github.com/actions/jekyll-build-pages/blob/649f5d3c2b2462620c8945f034200e431ceddd29/action.yml#LL31C54-L31C60\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factions%2Fjekyll-build-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factions%2Fjekyll-build-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factions%2Fjekyll-build-pages/lists"}