https://github.com/withastro/action

A GitHub Action that deploys your Astro project to GitHub Pages
https://github.com/withastro/action

Last synced: 27 days ago
JSON representation

A GitHub Action that deploys your Astro project to GitHub Pages

• Host: GitHub
• URL: https://github.com/withastro/action
• Owner: withastro
• License: other
• Created: 2022-08-07T21:29:17.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-02T09:30:32.000Z (2 months ago)
• Last Synced: 2024-10-05T23:30:45.904Z (29 days ago)
• Homepage:
• Size: 59.6 KB
• Stars: 154
• Watchers: 14
• Forks: 34
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Deploy Astro to GitHub Pages

This action for [Astro](https://github.com/withastro/astro) builds your static Astro project for [GitHub Pages](https://pages.github.com/).

For more information, please see our complete deployment guide—[Deploy your Astro Site to GitHub Pages](https://docs.astro.build/en/guides/deploy/github/).

## Usage

> **Note**: Want to get started even faster? Create a repository from our official [GitHub Pages template](https://github.com/withastro/github-pages)!

### Inputs

- `path` - Optional: the root location of your Astro project inside the repository.

- `node-version` - Optional: the specific version of Node that should be used to build your site. Defaults to `20`.

- `package-manager` - Optional: the Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. Accepted values: `npm`, `yarn`, `pnpm`, and `bun`. A version tag is also accepted, for example `[email protected]`, `pnpm@8`, or `bun@latest`. If not provided, version will default to `latest`.

### Example workflow:

#### Build and Deploy to GitHub Pages

Create a file at `.github/workflows/deploy.yml` with the following content.

```yml

name: Deploy to GitHub Pages

on:

  # Trigger the workflow every time you push to the `main` branch

  # Using a different branch name? Replace `main` with your branch’s name

  push:

    branches: [main]

  # Allows you to run this workflow manually from the Actions tab on GitHub.

  workflow_dispatch:

# Allow this job to clone the repo and create a page deployment

permissions:

  contents: read

  pages: write

  id-token: write

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout your repository using git

        uses: actions/checkout@v4

      - name: Install, build, and upload your site output

        uses: withastro/action@v2

        # with:

            # path: . # The root location of your Astro project inside the repository. (optional)

            # node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)

            # package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)

  deploy:

    needs: build

    runs-on: ubuntu-latest

    environment:

      name: github-pages

      url: ${{ steps.deployment.outputs.page_url }}

    steps:

      - name: Deploy to GitHub Pages

        id: deployment

        uses: actions/deploy-pages@v4

```