{"id":38515288,"url":"https://github.com/rehanhaider/pelican-to-github-pages","last_synced_at":"2026-01-17T06:28:17.709Z","repository":{"id":51915296,"uuid":"384716098","full_name":"rehanhaider/pelican-to-github-pages","owner":"rehanhaider","description":"Automated deployment of Pelican SSG generated static websites to GitHub Pages","archived":false,"fork":false,"pushed_at":"2024-04-06T08:50:52.000Z","size":14,"stargazers_count":15,"open_issues_count":2,"forks_count":13,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-18T06:47:41.815Z","etag":null,"topics":["deployment","github-pages","pelican","python3"],"latest_commit_sha":null,"homepage":"","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/rehanhaider.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}},"created_at":"2021-07-10T14:23:24.000Z","updated_at":"2025-04-30T14:21:21.000Z","dependencies_parsed_at":"2024-06-20T23:21:49.238Z","dependency_job_id":"f5feaa98-9cce-4f5a-bc7a-a6b7452a37e1","html_url":"https://github.com/rehanhaider/pelican-to-github-pages","commit_stats":{"total_commits":10,"total_committers":3,"mean_commits":"3.3333333333333335","dds":0.4,"last_synced_commit":"96096788e677dfef46f2a6aec2a8a98ca7dbc5ec"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/rehanhaider/pelican-to-github-pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rehanhaider%2Fpelican-to-github-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rehanhaider%2Fpelican-to-github-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rehanhaider%2Fpelican-to-github-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rehanhaider%2Fpelican-to-github-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rehanhaider","download_url":"https://codeload.github.com/rehanhaider/pelican-to-github-pages/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rehanhaider%2Fpelican-to-github-pages/sbom","scorecard":{"id":769187,"data":{"date":"2025-08-18","repo":{"name":"github.com/rehanhaider/pelican-to-github-pages","commit":"43296ecfcc8eb72bde088dd2c024579fd3b91f03"},"scorecard":{"version":"v5.2.1-41-g40576783","commit":"40576783fda6698350fcbbeaea760ff827433034"},"score":3.3,"checks":[{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#token-permissions"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#dangerous-workflow"}},{"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/40576783fda6698350fcbbeaea760ff827433034/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/40576783fda6698350fcbbeaea760ff827433034/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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":4,"reason":"Found 4/10 approved changesets -- score normalized to 4","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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#code-review"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#cii-best-practices"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#vulnerabilities"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#security-policy"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#fuzzing"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#branch-protection"}},{"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/40576783fda6698350fcbbeaea760ff827433034/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 python:3.8.18-slim to python:3.8.18-slim@sha256:e796941013b10bb53a0924d8705485a1afe654bbbc6fe71d32509101e44b6414","Warn: downloadThenRun not pinned by hash: Dockerfile:18","Warn: pipCommand not pinned by hash: entrypoint.sh:12","Warn: npmCommand not pinned by hash: entrypoint.sh:17","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   1 downloadThenRun dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned","Info:   0 out of   1 npmCommand 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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 11 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T01:46:07.054Z","repository_id":51915296,"created_at":"2025-08-23T01:46:07.054Z","updated_at":"2025-08-23T01:46:07.054Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28502277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T04:31:57.058Z","status":"ssl_error","status_checked_at":"2026-01-17T04:31:45.816Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["deployment","github-pages","pelican","python3"],"created_at":"2026-01-17T06:28:17.632Z","updated_at":"2026-01-17T06:28:17.696Z","avatar_url":"https://github.com/rehanhaider.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deploy Pelican to Github Pages\n\nAutomated deployment of Pelican SSG generated static websites to GitHub Pages. \n\nGitHub Pages can serve webpages from three predefined places\n1. **main/root**: The root folder of the main branch\n2. **main/docs**: Doc folder in the main branch\n2. **gh-pages/root**: The root folder of any branch named \"gh-pages\"\n\n## Prerequisites\n1. Your working directory should be in the `main` branch of your repository. \n2. Ensure you have captured your dependencies in `requirements.txt`. If not you can run the below command\n```bash\npip freeze \u003e requirements.txt\n```\n\n## Steps to use\nFirst create a file named at the path `.github/.workflows/pelican.yml`\nThe conents of the file should be \n```yaml\nname: Deploy\n\non:\n  # Trigger the workflow on push on main branch,\n  push:\n    branches:\n      - main\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v2\n      with: \n        submodules: 'true'\n    - uses: rehanhaider/pelican-to-github-pages@v1.0.3\n      env:\n        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}\n        GH_PAGES_CNAME: ${{secrets.DOMAIN_CNAME}}\n```\n\nThen, setup a secrets in your repository named `DOMAIN_CNAME` that should contain the URL of your custom domain without the protocol, e.g. `example.com`. This is only required if you have a custom domain, if you want to use the `*.github.io` subdomain, then you don't need this. \n\n## Default configuration and overrides\nThis GitHub action will generate the static website using the following defaults\n1. Configuration: Using `publishconf.py` as the default configuration file\n2. Content: Uses `content` as the default content directory\n\nYou can override them by adding the following in the pelican.yml file under env variables\n```yaml\nPELICAN_CONFIG_FILE: config-file-name\nPELICAN_CONTENT_FOLDER: content-folder-name\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frehanhaider%2Fpelican-to-github-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frehanhaider%2Fpelican-to-github-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frehanhaider%2Fpelican-to-github-pages/lists"}