actions/deploy-pages
1
0
Fork 0
mirror of https://github.com/actions/deploy-pages.git synced 2026-02-11 12:51:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README with info on Environment Variables set

Browse Source
This commit is contained in:
James M. Greene
2023-04-17 23:35:32 -05:00
parent 3a8a04e5ad
commit 5aacbeac9b
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -44,7 +44,7 @@ jobs:
uses: actions/deploy-pages@vX.X.X # <--- The latest version of this action
```
## Inputs 📥
### Inputs 📥
| Input | Required? | Default | Description |
| ----- | --------- | ------- | ----------- |
@@ -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.