Skip to content

keithnet/astroaction

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Deploy Astro to Zip File

This action for Astro builds your static Astro project and makes a zip file of the file.

Usage

Note: Want to get started even faster? Create a repository from our official GitHub Pages template!

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 22.
  • 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, bun, and deno. A version tag is also accepted, for example npm@11.6.2, pnpm@10, bun@latest, or deno@v2.x. If not provided, version will default to latest.
  • build-cmd - Optional: the command to run to build your site. Defaults to deno task build for sites using Deno and to <package-manager> run build for all other package managers.

Example workflow:

Build and Zip

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

name: Deploy to Zip File

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@v5
      - name: Install, build, and upload your site output
        uses: keithnet/astroaction@v5
        # with:
            # path: . # The root location of your Astro project inside the repository. (optional)
            # node-version: 22 # The specific version of Node that should be used to build your site. Defaults to 22. (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)
            # build-cmd: pnpm run build # The command to run to build your site. Runs the package build script/task by default. (optional)

About

A GitHub Action that complies Astro project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published