{"id":23263712,"url":"https://github.com/danielbayley/qwik-build","last_synced_at":"2025-08-20T19:31:12.007Z","repository":{"id":213010088,"uuid":"714351263","full_name":"danielbayley/qwik-build","owner":"danielbayley","description":"GitHub @Actions to build your Qwik static site for GitHub Pages.","archived":false,"fork":false,"pushed_at":"2023-12-24T10:33:25.000Z","size":1677,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-18T09:41:23.880Z","etag":null,"topics":["action","actions","build","ci","deploy","deployment","devops","github-action","github-actions","pages","publish","publishing","qwik","qwik-city","react","ssg","static","static-site","static-site-generator","static-website"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/qwik-build","language":null,"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/danielbayley.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,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"danielbayley","custom":["https://paypal.me/danieljbayley","BTC 37rdZq4muDVNJh6jCr4XDXf8X2EFKjL3QQ","ETH 0x6248B4349e633969376dA20F9C8577530062BE64"]}},"created_at":"2023-11-04T16:47:09.000Z","updated_at":"2024-02-05T15:13:58.000Z","dependencies_parsed_at":"2023-12-24T11:19:33.781Z","dependency_job_id":"2740a853-d7ad-4b5c-bfc0-f3fb1b0feb17","html_url":"https://github.com/danielbayley/qwik-build","commit_stats":null,"previous_names":["danielbayley/qwik-build"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbayley%2Fqwik-build","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbayley%2Fqwik-build/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbayley%2Fqwik-build/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbayley%2Fqwik-build/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielbayley","download_url":"https://codeload.github.com/danielbayley/qwik-build/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230445958,"owners_count":18227071,"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":["action","actions","build","ci","deploy","deployment","devops","github-action","github-actions","pages","publish","publishing","qwik","qwik-city","react","ssg","static","static-site","static-site-generator","static-website"],"created_at":"2024-12-19T14:19:55.020Z","updated_at":"2024-12-19T14:19:56.206Z","avatar_url":"https://github.com/danielbayley.png","language":null,"funding_links":["https://github.com/sponsors/danielbayley","https://paypal.me/danieljbayley","BTC 37rdZq4muDVNJh6jCr4XDXf8X2EFKjL3QQ","ETH 0x6248B4349e633969376dA20F9C8577530062BE64"],"categories":[],"sub_categories":[],"readme":"[\u003cimg src=\"logo.svg\" align=\"right\" width=\"11%\"\u003e][qwik]\n\n_[Qwik]_ Build\n==============\nGitHub [Action] to `build` your Qwik[[_City_]] [static] site for GitHub [Pages].\n\nUsage\n-----\nFirst enable GitHub Pages under your repository `Settings` \u003e `Pages`\nby changing the source to `GitHub Actions`:\n\n![screenshot](screenshot.png)\n\nThis action will look in [`package.`][[`yaml`]/`json`] [`scripts`] for the first script\ncontaining a `qwik`[`build`] command and [`run`] it with [[`p`]]`npm` or [`yarn`], as [appropriate]:\n~~~ js\n// package.json\n\"devDependencies\": {\n  \"@builder.io/qwik\": \"^1.x\",\n  \"eslint\": \"^8.x\",\n  \"vite\": \"^5.x\"\n},\n\"scripts\": {\n  \"lint\": \"eslint .\",\n  \"build\": \"qwik build\", // [p]npm/yarn run build\n  \"dev\": \"vite --mode ssr\"\n}\n~~~\nit will also [config]ure Qwik for [static] site generation, unless you already `run qwik add static`.\n\nBecause it runs the appropriate `build` script, support for _[Civet]_\n—a language that compiles to [TypeScript] and [JSX]—can be added:\n~~~ yaml\n# package.yaml\npackageManager: pnpm@8.12.1\ndevDependencies:\n  \"@builder.io/qwik\": ^1.x\n  \"@danielx/civet\": ^0.x\nscripts:\n  prebuild: civet --compile src/**/*.civet --output .tsx\n  build: qwik build # pnpm run build\n~~~\nAlthough a more official [integration] is preferred.\n\nOptions\n---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\n| [`inputs`]            | Default             | Description                                                                                                                     |\n|:----------------------|:--------------------|:--------------------------------------------------------------------------------------------------------------------------------|\n| `access-token`        | [`github.token`]    | Provide a token with permission to automatically enable Pages. [Generate] an [access token], then add to your repo [`secrets`]. |\n| `branch`              | [`github.ref_name`] | Optionally specify a particular `branch` of your repository.                                                                    |\n| `working-dir`         | `github.workspace`  | Optionally specify a subfolder containing source files.                                                                         |\n| `build-dir`           | [`dist`]            | Optionally specify an alternative `build` folder.                                                                               |\n| `node-version`        |                     | Optionally specify a _[SemVer]_ range or particular version of _[Node.js]_.                                                     |\n| [`node-version-file`] | [`package.json`]    | Optionally specify a file containing the correct version of Node.                                                               |\n\nExample\n-------\n`.github/workflows/pages.yml`:\n~~~ yaml\non:\n  push:\n    branches: site\n\npermissions:\n  pages: write\n  id-token: write\n\nconcurrency:\n  group: pages\n  cancel-in-progress: false\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    environment:\n      name: github-pages\n      url: ${{ steps.qwik-build.outputs.page-url }}\n\n    steps:\n    - name: Qwik Build\n      id: qwik-build\n      uses: danielbayley/qwik-build@v1\n      with:\n        branch: site\n~~~\n\nLicense\n-------\n[MIT] © [Daniel Bayley]\n\n[MIT]:                  LICENSE.md\n[Daniel Bayley]:        https://github.com/danielbayley\n\n[action]:               https://docs.github.com/actions\n[`inputs`]:             https://docs.github.com/actions/creating-actions/metadata-syntax-for-github-actions#inputs\n[generate]:             https://github.com/settings/tokens\n[access token]:         https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\n[`github.token`]:       https://docs.github.com/actions/security-guides/automatic-token-authentication\n[`secrets`]:            https://docs.github.com/actions/security-guides/encrypted-secrets\n[`github.ref_name`]:    https://docs.github.com/actions/learn-github-actions/contexts#github-context\n[pages]:                https://pages.github.com\n\n[semver]:               https://semver.org\n[node.js]:              https://nodejs.org\n[`node-version-file`]:  https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#node-version-file\n[`package.json`]:       https://docs.npmjs.com/cli/configuring-npm/package-json#engines\n[`package.`]:           https://docs.npmjs.com/cli/configuring-npm/package-json\n[`yaml`]:               https://github.com/pnpm/pnpm/pull/1799\n[`scripts`]:            https://docs.npmjs.com/cli/using-npm/scripts\n[appropriate]:          https://github.com/lerepo/workspace-tools/tree/master/packages/detect-pm-cli#readme\n[`yarn`]:               https://yarnpkg.com/cli\n[`p`]:                  https://pnpm.io\n[`run`]:                https://pnpm.io/cli/run\n\n[qwik]:                 https://qwik.builder.io\n[_city_]:               https://qwik.builder.io/docs/qwikcity#qwik-city\n[static]:               https://qwik.builder.io/docs/guides/static-site-generation\n[config]:               https://qwik.builder.io/docs/guides/static-site-generation#static-site-generation-config\n[`build`]:              https://qwik.builder.io/docs/deployments/gcp-cloud-run#production-build\n[`dist`]:               https://qwik.builder.io/docs/advanced/custom-build-dir\n\n[typescript]:           https://typescriptlang.org\n[jsx]:                  https://react.dev/learn/writing-markup-with-jsx\n[civet]:                https://civet.dev\n[integration]:          https://civet.dev/getting-started#building-a-project\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielbayley%2Fqwik-build","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielbayley%2Fqwik-build","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielbayley%2Fqwik-build/lists"}