Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielbayley/qwik-build
GitHub @Actions to build your Qwik static site for GitHub Pages.
https://github.com/danielbayley/qwik-build
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
Last synced: about 2 months ago
JSON representation
GitHub @Actions to build your Qwik static site for GitHub Pages.
- Host: GitHub
- URL: https://github.com/danielbayley/qwik-build
- Owner: danielbayley
- License: mit
- Created: 2023-11-04T16:47:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-24T10:33:25.000Z (about 1 year ago)
- Last Synced: 2024-04-18T09:41:23.880Z (10 months ago)
- 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
- Homepage: https://github.com/marketplace/actions/qwik-build
- Size: 1.6 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[
][qwik]
_[Qwik]_ Build
==============
GitHub [Action] to `build` your Qwik[[_City_]] [static] site for GitHub [Pages].
Usage
-----
First enable GitHub Pages under your repository `Settings` > `Pages`
by changing the source to `GitHub Actions`:
This action will look in [`package.`][[`yaml`]/`json`] [`scripts`] for the first script
containing a `qwik`[`build`] command and [`run`] it with [[`p`]]`npm` or [`yarn`], as [appropriate]:
~~~ js
// package.json
"devDependencies": {
"@builder.io/qwik": "^1.x",
"eslint": "^8.x",
"vite": "^5.x"
},
"scripts": {
"lint": "eslint .",
"build": "qwik build", // [p]npm/yarn run build
"dev": "vite --mode ssr"
}
~~~
it will also [config]ure Qwik for [static] site generation, unless you already `run qwik add static`.
Because it runs the appropriate `build` script, support for _[Civet]_
—a language that compiles to [TypeScript] and [JSX]—can be added:
~~~ yaml
# package.yaml
packageManager: [email protected]
devDependencies:
"@builder.io/qwik": ^1.x
"@danielx/civet": ^0.x
scripts:
prebuild: civet --compile src/**/*.civet --output .tsx
build: qwik build # pnpm run build
~~~
Although a more official [integration] is preferred.
Options
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| [`inputs`] | Default | Description |
|:----------------------|:--------------------|:--------------------------------------------------------------------------------------------------------------------------------|
| `access-token` | [`github.token`] | Provide a token with permission to automatically enable Pages. [Generate] an [access token], then add to your repo [`secrets`]. |
| `branch` | [`github.ref_name`] | Optionally specify a particular `branch` of your repository. |
| `working-dir` | `github.workspace` | Optionally specify a subfolder containing source files. |
| `build-dir` | [`dist`] | Optionally specify an alternative `build` folder. |
| `node-version` | | Optionally specify a _[SemVer]_ range or particular version of _[Node.js]_. |
| [`node-version-file`] | [`package.json`] | Optionally specify a file containing the correct version of Node. |
Example
-------
`.github/workflows/pages.yml`:
~~~ yaml
on:
push:
branches: site
permissions:
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.qwik-build.outputs.page-url }}
steps:
- name: Qwik Build
id: qwik-build
uses: danielbayley/qwik-build@v1
with:
branch: site
~~~
License
-------
[MIT] © [Daniel Bayley]
[MIT]: LICENSE.md
[Daniel Bayley]: https://github.com/danielbayley
[action]: https://docs.github.com/actions
[`inputs`]: https://docs.github.com/actions/creating-actions/metadata-syntax-for-github-actions#inputs
[generate]: https://github.com/settings/tokens
[access token]: https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
[`github.token`]: https://docs.github.com/actions/security-guides/automatic-token-authentication
[`secrets`]: https://docs.github.com/actions/security-guides/encrypted-secrets
[`github.ref_name`]: https://docs.github.com/actions/learn-github-actions/contexts#github-context
[pages]: https://pages.github.com
[semver]: https://semver.org
[node.js]: https://nodejs.org
[`node-version-file`]: https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#node-version-file
[`package.json`]: https://docs.npmjs.com/cli/configuring-npm/package-json#engines
[`package.`]: https://docs.npmjs.com/cli/configuring-npm/package-json
[`yaml`]: https://github.com/pnpm/pnpm/pull/1799
[`scripts`]: https://docs.npmjs.com/cli/using-npm/scripts
[appropriate]: https://github.com/lerepo/workspace-tools/tree/master/packages/detect-pm-cli#readme
[`yarn`]: https://yarnpkg.com/cli
[`p`]: https://pnpm.io
[`run`]: https://pnpm.io/cli/run
[qwik]: https://qwik.builder.io
[_city_]: https://qwik.builder.io/docs/qwikcity#qwik-city
[static]: https://qwik.builder.io/docs/guides/static-site-generation
[config]: https://qwik.builder.io/docs/guides/static-site-generation#static-site-generation-config
[`build`]: https://qwik.builder.io/docs/deployments/gcp-cloud-run#production-build
[`dist`]: https://qwik.builder.io/docs/advanced/custom-build-dir
[typescript]: https://typescriptlang.org
[jsx]: https://react.dev/learn/writing-markup-with-jsx
[civet]: https://civet.dev
[integration]: https://civet.dev/getting-started#building-a-project