{"id":40817958,"url":"https://github.com/gofunky/siteleaf-updater","last_synced_at":"2026-01-21T21:43:30.607Z","repository":{"id":39059913,"uuid":"173821604","full_name":"gofunky/siteleaf-updater","owner":"gofunky","description":"update the index file of your project's siteleaf project with your repository's README.md file","archived":false,"fork":false,"pushed_at":"2025-11-01T14:00:12.000Z","size":603,"stargazers_count":1,"open_issues_count":44,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-27T10:37:16.872Z","etag":null,"topics":["action","ci","docs","github-actions","github-pages","index","markdown","npm","readme","siteleaf","siteleaf-site","siteleaf-updater","sync","update"],"latest_commit_sha":null,"homepage":"https://siteleaf-updater.gofunky.fun","language":"JavaScript","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/gofunky.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-03-04T21:07:53.000Z","updated_at":"2021-02-22T17:47:46.000Z","dependencies_parsed_at":"2023-02-13T16:01:43.165Z","dependency_job_id":"0a5d2905-a680-4cb2-b178-5f74115b307c","html_url":"https://github.com/gofunky/siteleaf-updater","commit_stats":{"total_commits":178,"total_committers":7,"mean_commits":"25.428571428571427","dds":0.5,"last_synced_commit":"4d4c6634df8d214df646e0c5b853320b046c6251"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/gofunky/siteleaf-updater","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gofunky%2Fsiteleaf-updater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gofunky%2Fsiteleaf-updater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gofunky%2Fsiteleaf-updater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gofunky%2Fsiteleaf-updater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gofunky","download_url":"https://codeload.github.com/gofunky/siteleaf-updater/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gofunky%2Fsiteleaf-updater/sbom","scorecard":{"id":433802,"data":{"date":"2025-08-11","repo":{"name":"github.com/gofunky/siteleaf-updater","commit":"4d4c6634df8d214df646e0c5b853320b046c6251"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/14 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":"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":"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":"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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/dist.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Info: no jobLevel write permissions found"],"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:105: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dist.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/dist.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dist.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/dist.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dist.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/dist.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dist.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/dist.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:93: update your workflow using https://app.stepsecurity.io/secureworkflow/gofunky/siteleaf-updater/publish.yml/master?enable=pin","Info:   0 out of  14 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   6 third-party GitHubAction 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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE: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":"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"}},{"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"29 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-7r3h-m5j6-3q42","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-jjf5-wx3j-3fv7","Warn: Project is vulnerable to: GHSA-x2w5-725j-gf2g","Warn: Project is vulnerable to: GHSA-4jrm-c32x-w4jf","Warn: Project is vulnerable to: GHSA-h452-7996-h45h","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T04:05:40.353Z","repository_id":39059913,"created_at":"2025-08-19T04:05:40.353Z","updated_at":"2025-08-19T04:05:40.353Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28644149,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T21:29:11.980Z","status":"ssl_error","status_checked_at":"2026-01-21T21:24:31.872Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["action","ci","docs","github-actions","github-pages","index","markdown","npm","readme","siteleaf","siteleaf-site","siteleaf-updater","sync","update"],"created_at":"2026-01-21T21:43:30.545Z","updated_at":"2026-01-21T21:43:30.598Z","avatar_url":"https://github.com/gofunky.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# siteleaf-updater\n\n[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/gofunky/siteleaf-updater/build/master?style=for-the-badge)](https://github.com/gofunky/siteleaf-updater/actions)\n[![Renovate Status](https://img.shields.io/badge/renovate-enabled-green?style=for-the-badge\u0026logo=renovatebot\u0026color=1a1f6c)](https://app.renovatebot.com/dashboard#github/gofunky/siteleaf-updater)\n[![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/siteleaf-updater?style=for-the-badge)](https://libraries.io/npm/siteleaf-updater)\n[![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/siteleaf-updater?style=for-the-badge)](https://snyk.io/test/github/gofunky/siteleaf-updater)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-purple.svg?style=for-the-badge)](https://standardjs.com)\n[![CodeFactor](https://www.codefactor.io/repository/github/gofunky/siteleaf-updater/badge?style=for-the-badge)](https://www.codefactor.io/repository/github/gofunky/siteleaf-updater)\n[![node-current](https://img.shields.io/node/v/siteleaf-updater?style=for-the-badge)](https://www.npmjs.com/package/siteleaf-updater)\n[![NPM version](https://img.shields.io/npm/v/siteleaf-updater?style=for-the-badge)](https://www.npmjs.com/package/siteleaf-updater)\n[![NPM Downloads](https://img.shields.io/npm/dm/siteleaf-updater?style=for-the-badge\u0026color=ff69b4)](https://www.npmjs.com/package/siteleaf-updater)\n[![GitHub License](https://img.shields.io/github/license/gofunky/siteleaf-updater.svg?style=for-the-badge)](https://github.com/gofunky/siteleaf-updater/blob/master/LICENSE)\n[![GitHub last commit](https://img.shields.io/github/last-commit/gofunky/siteleaf-updater.svg?style=for-the-badge\u0026color=9cf)](https://github.com/gofunky/siteleaf-updater/commits/master)\n\nupdate the index file of your project's siteleaf project with your repository's README.md file\n\n## Why it is necessary\n\nWhen hosting GitHub Pages, there is a common discrepancy one faces when choosing the place to host their page files.\n\n### 1. Host it on the master branch\n\nHosting GitHub Pages the master branch has the advantage that files can be shared with the project (including the README).\nHowever, pages usually stand alone without a dependency to or from the project's files.\nHence, there might be numerous commits that cause an avoidable overhead to merges, CI, and pulls.\n\n### 2. Host it on a dedicated branch\n\nHosting the pages on a dedicated branch (e.g., `gh-pages`) has the benefit that this beforementioned overhead is avoided.\nSeparate concerns are rooted in separate trees, just as it is supposed to be.\nHowever, normally, developers only want to publish their README with a few additions.\nThere is no integrated way or known method in GitHub to sync the README file without hooks or different workarounds.\nThis circumstance impairs common maintenance and automation requirements.\n\n## Solution\n\n1. Use [Siteleaf](https://www.siteleaf.com/), and publish or sync to a dedicated branch on GitHub.\n2. Create a page and assign it a path (i.e. `index` by default).\n3. Setup your CI to use `siteleaf-updater` for automated doc updates.\n\n## Parameters\n\n| Action Input | CLI Parameter | Environment Variable | Default | Description |  \n| ------ | ------ | ------ | ------ | ------ |  \n| api-key | api-key | SITELEAF_API_KEY | *required* | the API key that grants access to the repository's siteleaf project |   \n| api-secret | api-secret | SITELEAF_API_SECRET | *required* | the API secret that grants access to the repository's siteleaf project |   \n| site | site | SITELEAF_SITE | *required* | the id of the siteleaf site to be updated |   \n| page | page | SITELEAF_PAGE | `index` | the target page of the siteleaf site to be updated |   \n| file | file | SITELEAF_MD_SOURCE | `README.md` | the path to the local Markdown file to push |\n| publish | publish | - | `false` | allows publishing the site after its update |\n\n## Action Example\n\n```yaml\nsteps:\n  - name: update site\n    uses: gofunky/siteleaf-updater@v2\n    with:\n      api-key: ${{ secrets.SITELEAF_KEY }}\n      api-secret: ${{ secrets.SITELEAF_SECRET }}\n      site: 'my-site'\n      page: 'contribution'\n      file: 'CONTRIBUTION.md'\n      publish: true\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgofunky%2Fsiteleaf-updater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgofunky%2Fsiteleaf-updater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgofunky%2Fsiteleaf-updater/lists"}