{"id":13806848,"url":"https://github.com/k9n-dev/analog-publish-gh-pages","last_synced_at":"2026-03-10T18:31:16.632Z","repository":{"id":214537963,"uuid":"736751218","full_name":"k9n-dev/analog-publish-gh-pages","owner":"k9n-dev","description":"A Github Action for the Deployment of an Analog.js App on Github Pages","archived":false,"fork":false,"pushed_at":"2024-08-05T05:58:10.000Z","size":610,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-17T11:12:39.400Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/k9n-dev.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-28T19:12:58.000Z","updated_at":"2025-07-24T14:37:21.000Z","dependencies_parsed_at":"2024-03-13T21:30:24.308Z","dependency_job_id":"c7ed1dbc-62b3-4c3a-8524-ba303c801e33","html_url":"https://github.com/k9n-dev/analog-publish-gh-pages","commit_stats":null,"previous_names":["d-koppenhagen/analog-publish-gh-pages","k9n-dev/analog-publish-gh-pages"],"tags_count":4,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/k9n-dev/analog-publish-gh-pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k9n-dev%2Fanalog-publish-gh-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k9n-dev%2Fanalog-publish-gh-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k9n-dev%2Fanalog-publish-gh-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k9n-dev%2Fanalog-publish-gh-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/k9n-dev","download_url":"https://codeload.github.com/k9n-dev/analog-publish-gh-pages/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k9n-dev%2Fanalog-publish-gh-pages/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30347379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T15:55:29.454Z","status":"ssl_error","status_checked_at":"2026-03-10T15:54:58.440Z","response_time":106,"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":[],"created_at":"2024-08-04T01:01:17.032Z","updated_at":"2026-03-10T18:31:16.571Z","avatar_url":"https://github.com/k9n-dev.png","language":"TypeScript","funding_links":[],"categories":["Angular"],"sub_categories":["Deployment"],"readme":"# Analog Publish GitHub Pages\n\n![CI](https://github.com/k9n-dev/analog-publish-gh-pages/actions/workflows/ci.yml/badge.svg)\n[![Check dist/](https://github.com/k9n-dev/analog-publish-gh-pages/actions/workflows/check-dist.yml/badge.svg)](https://github.com/k9n-dev/analog-publish-gh-pages/actions/workflows/check-dist.yml)\n[![CodeQL](https://github.com/k9n-dev/analog-publish-gh-pages/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/k9n-dev/analog-publish-gh-pages/actions/workflows/codeql-analysis.yml)\n[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)\n\nBuild a static [AnalogJS](https://analogjs.org/) site and deploy it on GitHub\nPages.\n\n## Versions and Compatibility\n\nTested with Node `20`, Angular `^17.0.0` and AnalogJS `1.0.0-beta.1`.\n\n## Usage\n\n```yaml\nname: Build and Deploy\n\non:\n  push:\n    branches:\n      - 'main'\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: actions/setup-node@v4\n        with:\n          node-version: '20.x'\n      - uses: k9n-dev/analog-publish-gh-pages@v1.0.0\n        with:\n          # Required: token to access / deploy on GitHub Pages\n          access-token: ${{ secrets.ACCESS_TOKEN }}\n          # Optional: arguments passed to `npm ci`\n          install-args: '--legacy-peer-deps'\n          # Optional: arguments passed to `npm run build`\n          build-args: ''\n          # Optional: the directory after build process to deploy (defaults to `dist/analog/public`)\n          deploy-dir: 'dist/analog/public'\n          # Optional: a specific branch where the static site should be deployed (defaults to `gh-pages`)\n          deploy-branch: 'gh-pages' # important: --dry-run (see option below) won't actually deploy the site!\n          # Optional: prevent an actual deployment (e. g. for running in branch pipelines)\n          dry-run: true\n```\n\n## Options (`with`)\n\n\u003e To deploy, you need to provide a [personal\n\u003e `access-token`][github-access-token]. This token must be configured as a\n\u003e [Repository Secret][github-repo-secret].\n\n\u003c!-- START: table generated from actions.yml --\u003e\n\n| input           | required | default              | description                                                                                                           |\n| --------------- | -------- | -------------------- | --------------------------------------------------------------------------------------------------------------------- |\n| package-manager | `false`  | `npm`                | The package manager to be used (`npm`, `yarn`, `pnpm`).                                                               |\n| access-token    | `true`   | -                    | A personal access token needed to deploy your site after it has been built.                                           |\n| install-args    | `false`  | -                    | Additional arguments that get passed to the install command of the used package manager (e. g. `--legacy-peer-deps`). |\n| build-args      | `false`  | -                    | Additional arguments that get passed to `build` script of your `package.json` file.                                   |\n| deploy-dir      | `false`  | `dist/analog/public` | The path to the directory to deploy.                                                                                  |\n| deploy-branch   | `false`  | `gh-pages`           | The branch where the static site should be deployed.                                                                  |\n| dry-run         | `false`  | `false`              | Don't actually deploy if truthy.                                                                                      |\n\n\u003c!-- END: table generated from actions.yml --\u003e\n\n## Assumptions\n\n### Build command\n\nThe `build` script of your `package.json` is executed by this action. Additional\narguments can be passed by setting `build-args`.\n\n### `CNAME` file\n\nYou have a custom domain you would like to use? Fancy! 😎 This Action's got you\ncovered! Assuming you have already set up your DNS provider as defined in the\n[GitHub Pages docs][github-pages-domain-docs], all we need next is a `CNAME`\nfile at the root of your project with the domain you would like to use. For\nexample:\n\n```CNAME\nexample.com\n```\n\n### `.nojekyll` file\n\nAnalogJS creates files starting with an underscore (`_`) during the build\nprocess. By default GitHub Pages assumes a Jekyll project is being published.\nThis assumption comes with the fact, all files starting with `_` are being\nignored. To fix this, the actions adds a `.nojekyll` file to the destination\ndirectory and places it in the root on the `gh-pages` branch.\n\n[github-access-token]:\n  https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line\n[github-pages-domain-docs]:\n  https://help.github.com/en/articles/using-a-custom-domain-with-github-pages\n[github-repo-secret]:\n  https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#creating-encrypted-secrets\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fk9n-dev%2Fanalog-publish-gh-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fk9n-dev%2Fanalog-publish-gh-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fk9n-dev%2Fanalog-publish-gh-pages/lists"}