Skip to content

README: name what the run page now shows #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shipstatic-com wants to merge 2 commits into
base: main
Choose a base branch
from
Open

README: name what the run page now shows #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
618f279
the README names what the run page now shows
shipstatic-com Aug 12, 2026
ddbe58f
the domain example stops writing a summary the action writes
shipstatic-com Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/workflows/deploy-domain.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@ jobs:
steps:
- uses: actions/checkout@v7
- run: npm ci && npm run build
- id: deploy
uses: shipstatic/action@v2
- uses: shipstatic/action@v2
with:
token: ${{ secrets.SHIP_TOKEN }}
path: ./dist
domain: ${{ vars.DOMAIN }}
github-token: ${{ secrets.GITHUB_TOKEN }}
- run: echo "Deployed to ${{ steps.deploy.outputs.url }}" >> "$GITHUB_STEP_SUMMARY"
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Example workflows for the [ShipStatic GitHub Action](https://github.com/marketplace/actions/shipstatic) — a React + Vite app deployed to [action-example.shipstatic.com](https://action-example.shipstatic.com).

Every one of them writes a summary to its workflow run page — the deployment, its URL, the domain when one is linked, and for deploys made without an API key the claim link and expiry. Nothing to configure.

## [`deploy-no-account.yml`](.github/workflows/deploy-no-account.yml) — Free, No Account Needed

Push to `main` deploys instantly. No API key, no sign-up, no configuration — expires in 3 days.
Expand Down Expand Up @@ -72,19 +74,17 @@ jobs:
steps:
- uses: actions/checkout@v7
- run: npm ci && npm run build
- id: deploy
uses: shipstatic/action@v2
- uses: shipstatic/action@v2
with:
token: ${{ secrets.SHIP_TOKEN }}
path: ./dist
domain: ${{ vars.DOMAIN }}
github-token: ${{ secrets.GITHUB_TOKEN }}
- run: echo "Deployed to ${{ steps.deploy.outputs.url }}" >> "$GITHUB_STEP_SUMMARY"
```

## [`preview-pr.yml`](.github/workflows/preview-pr.yml) — PR Preview

Every pull request gets a preview deploy with the URL posted as a comment. Works without an API key — expires in 3 days.
Every pull request gets a preview deploy with the URL posted as a comment — one comment per PR, updated in place on every push rather than a new one each time. Works without an API key — expires in 3 days, and the comment carries the claim link that keeps it.

```yaml
name: Preview
Expand Down