{"id":20258512,"url":"https://github.com/agentd00nut/jekyll-build-optional-deploy-gh-pages","last_synced_at":"2025-08-19T13:18:40.924Z","repository":{"id":65158758,"uuid":"223028198","full_name":"agentd00nut/jekyll-build-optional-deploy-gh-pages","owner":"agentd00nut","description":"A more configurable github actions jekyll repo builder with configurable deployment options.","archived":false,"fork":false,"pushed_at":"2020-01-23T19:09:53.000Z","size":16,"stargazers_count":7,"open_issues_count":1,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-18T15:48:48.425Z","etag":null,"topics":["actions","github-actions","github-pages","jekyll"],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/agentd00nut.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-20T21:10:33.000Z","updated_at":"2021-01-04T04:18:47.000Z","dependencies_parsed_at":"2023-01-05T04:51:00.293Z","dependency_job_id":null,"html_url":"https://github.com/agentd00nut/jekyll-build-optional-deploy-gh-pages","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.06666666666666665,"last_synced_commit":"bcee5de67e06acb0e6195bd65b35fba8ff24ec44"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/agentd00nut/jekyll-build-optional-deploy-gh-pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agentd00nut%2Fjekyll-build-optional-deploy-gh-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agentd00nut%2Fjekyll-build-optional-deploy-gh-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agentd00nut%2Fjekyll-build-optional-deploy-gh-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agentd00nut%2Fjekyll-build-optional-deploy-gh-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agentd00nut","download_url":"https://codeload.github.com/agentd00nut/jekyll-build-optional-deploy-gh-pages/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agentd00nut%2Fjekyll-build-optional-deploy-gh-pages/sbom","scorecard":{"id":170402,"data":{"date":"2025-08-11","repo":{"name":"github.com/agentd00nut/jekyll-build-optional-deploy-gh-pages","commit":"bcee5de67e06acb0e6195bd65b35fba8ff24ec44"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/15 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating ruby:2.4.0 to ruby:2.4.0@sha256:716dee5ca3d6f327a049c4e6c19ff22a0c3ebf0a65e33d28e576b16cd2b299ef","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-16T16:17:07.966Z","repository_id":65158758,"created_at":"2025-08-16T16:17:07.966Z","updated_at":"2025-08-16T16:17:07.966Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271159287,"owners_count":24709237,"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-08-19T02:00:09.176Z","response_time":63,"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":["actions","github-actions","github-pages","jekyll"],"created_at":"2024-11-14T11:09:24.778Z","updated_at":"2025-08-19T13:18:40.580Z","avatar_url":"https://github.com/agentd00nut.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Configurable Github Action For Building and Optionally Deploying Jekyll Builds.\r\n\r\nGoes to a configured directory, optionally destroys the Gemfile.lock, builds the jekyll site, and optionally goes to a configured directory to push to specified branch of the repo.\r\n\r\nReally helpful if you just want to build your site and let another action in your workflow do something with it... like [push to s3 maybe?](https://github.com/jakejarvis/s3-sync-action)\r\n\r\n## Options\r\n\r\nSet these in the `env` of the github action.\r\nBUILD_DIR and REMOTE_BRANCH don't matter if DEPLOY_SITE is not `true`... obviously.\r\n\r\n\r\n`JEKYLL_ROOT` **Default**:`./`  If your jekyll site isn't at the root if your repo, change this so that a `cd` command points to the jekyll root.\r\n\r\n\r\n`GEMFILE` **Default**:`Gemfile` If you aren't using a default named Gemfile; change its name here.\r\n\r\n\r\n`REMOVE_GEMLOCK` **Default**:`true` When `true` we'll `rm Gemfile.lock` before trying to build the jekyll site.\r\n\r\n\r\n`DELETE_BEFORE_BUILD` **Default**:`no default!`... If set calls `rm -rf \u003c\u003e` before building the site... Useful for removing directories you don't want in your final site for whatever reason.\r\n\r\n\r\n`DEPLOY_SITE` **Default**:`true` If we should try and build the site and deploy it the REMOTE_DIR.\r\n\r\n\r\n`BUILD_DIR` **Default**:`_site/` What directly will the site get built into.  *This is telling our deployment actions where to work, it does NOT change where your site gets built into, use your `_config.yml` for that*.\r\n\r\n\r\n`REMOTE_BRANCH` **Default**:`gh-pages` Which branch of the repo should we push our BUILD_DIR to?\r\n\r\n\r\n## Example\r\n\r\nThis would build and deploy the jekyll site contained within the `MySite` dir of the repo to the `staging` branch of the repo when ever the `dev` branch gets pushed to.\r\n\r\nChange `dev` to `master` if and remove the `JEKYLL_ROOT` and `REMOTE_BRANCH` `env` settings if you want vanilla default actions to happen when master gets pushed.\r\n\r\nThe `GITHUB_*` env variables are populated by github actions, they must be defined but you don't need to set them yourself. \r\n\r\n```yml\r\nname: Jekyll Build - Optional Deploy\r\n\r\non:\r\n  push:\r\n    branches:\r\n    - dev\r\n\r\njobs: \r\n  build_and_deploy:\r\n    runs-on: ubuntu-latest\r\n    steps:\r\n      - uses: actions/checkout@v1\r\n      - name: Building a jekyll site from configured directory, maybe deploying it.\r\n        env: \r\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\r\n          GITHUB_REPOSITORY: ${{ secrets.GITHUB_REPOSITORY }}\r\n          GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}\r\n          JEKYLL_ROOT: \"MySite/\"\r\n          REMOTE_BRANCH: \"staging\"\r\n        uses: agentd00nut/jekyll-build-optional-deploy-gh-pages@master\r\n```\r\n\r\n## Multiple sites\r\n\r\nThis isn't tested but it should be possible within the same job.  Just explicitly state all the env variables for each `- name`'d use of the action.  \r\n\r\n## Gotchas\r\n\r\n**Changes pushed to your gh-pages branch will only be picked up by the Github Pages server if your workflow is in a private repository.**\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagentd00nut%2Fjekyll-build-optional-deploy-gh-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagentd00nut%2Fjekyll-build-optional-deploy-gh-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagentd00nut%2Fjekyll-build-optional-deploy-gh-pages/lists"}