Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update README with info on Environment Variables set
  • Loading branch information
James M. Greene authored and James M. Greene committed Apr 18, 2023
1 parent 3a8a04e commit 5aacbea
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Expand Up @@ -44,7 +44,7 @@ jobs:
uses: actions/deploy-pages@vX.X.X # <--- The latest version of this action
```

## Inputs 📥
### Inputs 📥

| Input | Required? | Default | Description |
| ----- | --------- | ------- | ----------- |
Expand All @@ -57,12 +57,18 @@ jobs:
| `artifact_name` | `false` | `"github-pages"` | The name of the artifact to deploy |
| `preview` | `false` | `"false"` | Is this attempting to deploy a pull request as a GitHub Pages preview site? (NOTE: This feature is only in alpha currently and is not available to the public!) |

## Outputs 📤
### Outputs 📤

| Output | Description |
| ------ | ----------- |
| `page_url` | The URL of the deployed Pages site |

### Environment Variables 🌎

| Variable | Description |
| -------- | ----------- |
| `GITHUB_PAGES` | This environment variable is created and set to the string value `"true"` so that framework build tools may choose to differentiate their output based on the intended target hosting platform. |

## Scope

⚠️ Official support for building Pages with Actions is in public beta at the moment.
Expand Down

0 comments on commit 5aacbea

Please sign in to comment.