Skip to content

Commit

Permalink
Merge pull request #279 from actions/artifacts-next-ga
Browse files Browse the repository at this point in the history
Use artifacts v4
  • Loading branch information
TooManyBees authored Dec 19, 2023
2 parents 13b55b3 + 0d45f33 commit f33f41b
Show file tree
Hide file tree
Showing 11 changed files with 1,079 additions and 6,006 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ This action is used to deploy [Actions artifacts][artifacts] to [GitHub Pages](h

## Usage

See [action.yml](action.yml) for the various `inputs` this action supports.
See [action.yml](action.yml) for the various `inputs` this action supports (or [below](#inputs-📥)).

For examples that make use of this action, check out our [starter-workflows][starter-workflows] in a variety of frameworks.

This action expects an artifact named `github-pages` to have been created prior to execution. This is done automatically when using [`actions/upload-pages-artifact`][upload-pages-artifact].
This action deploys a Pages site previously uploaded as an artifact (e.g. using [`actions/upload-pages-artifact`][upload-pages-artifact]).

We recommend this action to be used in a dedicated job:

Expand Down Expand Up @@ -71,7 +71,7 @@ jobs:

There are a few important considerations to be aware of:

1. The artifact being deployed must have been uploaded in a previous step, either in the same job or a separate job that doesn't execute until the upload is complete.
1. The artifact being deployed must have been uploaded in a previous step, either in the same job or a separate job that doesn't execute until the upload is complete. See [`actions/upload-pages-artifact`][upload-pages-artifact] for more information about the format of the artifact we expect.

2. The job that executes the deployment must at minimum have the following permissions:
- `pages: write`
Expand Down
Loading

0 comments on commit f33f41b

Please sign in to comment.