diff --git a/README.md b/README.md index 1ddf898..76a6330 100644 --- a/README.md +++ b/README.md @@ -12,22 +12,21 @@ If you breakdown your workflow in two jobs (`build` and `deploy`), we recommend jobs: # Build job build: - # Specify runner + build & upload the static files as an artifact runs-on: ubuntu-latest steps: - - name: Build static files - id: build - run: | - # - # At a minimum this step should build the static files of your site - # - - - name: Upload static files as artifact + - name: Build static files + id: build + run: | + # + # At a minimum this step should build the static files of your site + # + + - name: Upload static files as artifact id: deployment uses: actions/upload-pages-artifact@v3 # or specific "vX.X.X" version tag for this action - with: - path: build_outputs_folder/ + with: + path: build_outputs_folder/ # Deployment job deploy: @@ -40,16 +39,15 @@ jobs: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 - ``` ### Inputs 📥 -| Input | Required? | Default | Description | -| ---------------- | --------- | ----------------------- | -------------------------------------------------- | -| `name` | `false` | `github-pages` | Artifact name | -| `path` | `true` | `_site/` | Path of the directory containing the static assets | -| `retention-days` | `false` | `1` | Duration after which artifact will expire in days | +| Input | Required? | Default | Description | +| ---------------- | --------- | -------------- | -------------------------------------------------- | +| `name` | `false` | `github-pages` | Artifact name | +| `path` | `true` | `_site/` | Path of the directory containing the static assets | +| `retention-days` | `false` | `1` | Duration after which artifact will expire in days | ### Outputs 📤 @@ -57,7 +55,6 @@ jobs: | ------------- | ---------------------------------------- | | `artifact_id` | The ID of the artifact that was uploaded | - ## Artifact validation While choosing to use this action as part of your approach to deploying to GitHub Pages is technically optional, we highly recommend it since it takes care of producing (mostly) valid artifacts. @@ -83,7 +80,7 @@ In order to release a new version of this Action: 2. Publish the draft release from the `main` branch with semantic version as the tag name, _with_ the checkbox to publish to the GitHub Marketplace checked. :ballot_box_with_check: -3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v0`. +3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding major version tag such as `v0`. ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].