Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k9n-dev/analog-publish-gh-pages
A Github Action for the Deployment of an Analog.js App on Github Pages
https://github.com/k9n-dev/analog-publish-gh-pages
Last synced: 3 months ago
JSON representation
A Github Action for the Deployment of an Analog.js App on Github Pages
- Host: GitHub
- URL: https://github.com/k9n-dev/analog-publish-gh-pages
- Owner: k9n-dev
- License: mit
- Created: 2023-12-28T19:12:58.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T05:58:58.000Z (4 months ago)
- Last Synced: 2024-07-25T18:39:35.046Z (4 months ago)
- Language: TypeScript
- Size: 597 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-angular - analog-publish-gh-pages - A Github Action for the Deployment of an [Analog.js](https://analogjs.org) App on Github Pages. (Table of contents / Angular)
- fucking-awesome-angular - analog-publish-gh-pages - A Github Action for the Deployment of an 🌎 [Analog.js](analogjs.org) App on Github Pages. (Table of contents / Angular)
- fucking-awesome-angular - analog-publish-gh-pages - A Github Action for the Deployment of an 🌎 [Analog.js](analogjs.org) App on Github Pages. (Table of contents / Angular)
README
# Analog Publish GitHub Pages
[](https://github.com/k9n-dev/analog-publish-gh-pages/actions/workflows/check-dist.yml)
[](https://github.com/k9n-dev/analog-publish-gh-pages/actions/workflows/codeql-analysis.yml)
[](./badges/coverage.svg)
Build a static [AnalogJS](https://analogjs.org/) site and deploy it on GitHub
Pages.
## Versions and Compatibility
Tested with Node `20`, Angular `^17.0.0` and AnalogJS `1.0.0-beta.1`.
## Usage
```yaml
name: Build and Deploy
on:
push:
branches:
- 'main'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20.x'
- uses: k9n-dev/[email protected]
with:
# Required: token to access / deploy on GitHub Pages
access-token: ${{ secrets.ACCESS_TOKEN }}
# Optional: arguments passed to `npm ci`
install-args: '--legacy-peer-deps'
# Optional: arguments passed to `npm run build`
build-args: ''
# Optional: the directory after build process to deploy (defaults to `dist/analog/public`)
deploy-dir: 'dist/analog/public'
# Optional: a specific branch where the static site should be deployed (defaults to `gh-pages`)
deploy-branch: 'gh-pages' # important: --dry-run (see option below) won't actually deploy the site!
# Optional: prevent an actual deployment (e. g. for running in branch pipelines)
dry-run: true
```
## Options (`with`)
> To deploy, you need to provide a [personal
> `access-token`][github-access-token]. This token must be configured as a
> [Repository Secret][github-repo-secret].
| input | required | default | description |
| --------------- | -------- | -------------------- | --------------------------------------------------------------------------------------------------------------------- |
| package-manager | `false` | `npm` | The package manager to be used (`npm`, `yarn`, `pnpm`). |
| access-token | `true` | - | A personal access token needed to deploy your site after it has been built. |
| install-args | `false` | - | Additional arguments that get passed to the install command of the used package manager (e. g. `--legacy-peer-deps`). |
| build-args | `false` | - | Additional arguments that get passed to `build` script of your `package.json` file. |
| deploy-dir | `false` | `dist/analog/public` | The path to the directory to deploy. |
| deploy-branch | `false` | `gh-pages` | The branch where the static site should be deployed. |
| dry-run | `false` | `false` | Don't actually deploy if truthy. |
## Assumptions
### Build command
The `build` script of your `package.json` is executed by this action. Additional
arguments can be passed by setting `build-args`.
### `CNAME` file
You have a custom domain you would like to use? Fancy! 😎 This Action's got you
covered! Assuming you have already set up your DNS provider as defined in the
[GitHub Pages docs][github-pages-domain-docs], all we need next is a `CNAME`
file at the root of your project with the domain you would like to use. For
example:
```CNAME
example.com
```
### `.nojekyll` file
AnalogJS creates files starting with an underscore (`_`) during the build
process. By default GitHub Pages assumes a Jekyll project is being published.
This assumption comes with the fact, all files starting with `_` are being
ignored. To fix this, the actions adds a `.nojekyll` file to the destination
directory and places it in the root on the `gh-pages` branch.
[github-access-token]:
https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line
[github-pages-domain-docs]:
https://help.github.com/en/articles/using-a-custom-domain-with-github-pages
[github-repo-secret]:
https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#creating-encrypted-secrets