astro/docs/guides/deploy.md at 6287ec2b8e4aa844877f5b97d726105f90afd51f

natemoo-re 1bbe98ae54 [ci] yarn format

2021-07-07 20:10:09 +00:00

7.3 KiB

Raw Blame History

layout	title
~/layouts/Main.astro	Deploy Your Website

This page is based off of Vite's well-documented static deploy instructions.

The following guides are based on some shared assumptions:

You are using the default build output location (dist/). This location can be changed using the dist configuration option.
You are using npm. You can use equivalent commands to run the scripts if you are using Yarn or other package managers.
Astro is installed as a local dev dependency in your project, and you have setup the following npm scripts:

{
  "scripts": {
    "build": "astro build",
    "preview": "astro preview"
  }
}

Building The App

You may run npm run build command to build the app.

$ npm run build

By default, the build output will be placed at dist/. You may deploy this dist/ folder to any of your preferred platforms.

GitHub Pages

Set the correct buildOptions.site in astro.config.js.

Inside your project, create deploy.sh with the following content (with highlighted lines uncommented appropriately), and run it to deploy:

#!/usr/bin/env sh

# abort on errors
set -e

# build
npm run build

# navigate into the build output directory
cd dist

# if you are deploying to a custom domain
# echo 'www.example.com' > CNAME

git init
git add -A
git commit -m 'deploy'

# if you are deploying to https://<USERNAME>.github.io
# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master

# if you are deploying to https://<USERNAME>.github.io/<REPO>
# git push -f git@github.com:<USERNAME>/<REPO>.git master:gh-pages

cd -

You can also run the above script in your CI setup to enable automatic deployment on each push.

GitHub Actions

TODO: We'd love an example action snippet to share here!

Travis CI

Set the correct buildOptions.site in astro.config.js.
Create a file named .travis.yml in the root of your project.
Run npm install locally and commit the generated lockfile (package-lock.json).

Use the GitHub Pages deploy provider template, and follow the Travis CI documentation.

language: node_js
node_js:
  - lts/*
install:
  - npm ci
script:
  - npm run build
deploy:
  provider: pages
  skip_cleanup: true
  local_dir: dist
  # A token generated on GitHub allowing Travis to push code on you repository.
  # Set in the Travis settings page of your repository, as a secure variable.
  github_token: $GITHUB_TOKEN
  keep_history: true
  on:
    branch: master

GitLab Pages

Set the correct buildOptions.site in astro.config.js.
Set build.outDir in astro.config.js to public.

Create a file called .gitlab-ci.yml in the root of your project with the content below. This will build and deploy your site whenever you make changes to your content:

image: node:10.22.0
pages:
  cache:
    paths:
      - node_modules/
  script:
    - npm install
    - npm run build
  artifacts:
    paths:
      - public
  only:
    - master

Netlify

On Netlify, setup up a new project from GitHub with the following settings:
- Build Command: astro build or npm run build
- Publish directory: dist
Hit the deploy button.

Google Firebase

Make sure you have firebase-tools installed.

Create firebase.json and .firebaserc at the root of your project with the following content:

firebase.json:

{
  "hosting": {
    "public": "dist",
    "ignore": []
  }
}

.firebaserc:

{
 "projects": {
   "default": "<YOUR_FIREBASE_ID>"
 }
}

After running npm run build, deploy using the command firebase deploy.

Surge

First install surge, if you haven’t already.
Run npm run build.
Deploy to surge by typing surge dist.

You can also deploy to a custom domain by adding surge dist yourdomain.com.

Heroku

Install Heroku CLI.
Create a Heroku account by signing up.
Run heroku login and fill in your Heroku credentials:
```
$ heroku login
```
Create a file called static.json in the root of your project with the below content:

static.json:
```
{
  "root": "./dist"
}
```
This is the configuration of your site; read more at heroku-buildpack-static.

Set up your Heroku git remote:

# version change
$ git init
$ git add .
$ git commit -m "My site ready for deployment."

# creates a new app with a specified name
$ heroku apps:create example

# set buildpack for static sites
$ heroku buildpacks:set https://github.com/heroku/heroku-buildpack-static.git

Deploy your site:

# publish site
$ git push heroku master

# opens a browser to view the Dashboard version of Heroku CI
$ heroku open

Vercel

To deploy your Astro project with a Vercel for Git, make sure it has been pushed to a Git repository.

Go to https://vercel.com/import/git and import the project into Vercel using your Git of choice (GitHub, GitLab or BitBucket). Follow the wizard to select the project root with the project's package.json and override the build step using npm run build and the output dir to be ./dist

After your project has been imported, all subsequent pushes to branches will generate Preview Deployments, and all changes made to the Production Branch (commonly "main") will result in a Production Deployment.

Once deployed, you will get a URL to see your app live, such as the following: https://astro.vercel.app

Azure Static Web Apps

You can deploy your Astro project with Microsoft Azure Static Web Apps service. You need:

An Azure account and a subscription key. You can create a free Azure account here.
Your app code pushed to GitHub.
The SWA Extension in Visual Studio Code.

Install the extension in VS Code and navigate to your app root. Open the Static Web Apps extension, sign in to Azure, and click the '+' sign to create a new Static Web App. You will be prompted to designate which subscription key to use.

Follow the wizard started by the extension to give your app a name, choose a framework preset, and designate the app root (usually /) and built file location /dist. The wizard will run and will create a GitHub action in your repo in a .github folder.

The action will work to deploy your app (watch its progress in your repo's Actions tab) and, when successfully completed, you can view your app in the address provided in the extension's progress window by clicking the 'Browse Website' button that appears when the GitHub action has run.

7.3 KiB Raw Blame History Unescape Escape