Skip to content

Commit 18b2149

Browse files
committed
Update README.md
1 parent bf6e4f9 commit 18b2149

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

README.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,14 @@ This Action deploys a static site on GitHub Pages.
44

55
[![test](https://github.com/Cecilapp/GitHub-Pages-deploy/workflows/test/badge.svg)](https://github.com/Cecilapp/GitHub-Pages-deploy/actions?query=workflow%3Atest)
66

7-
> _GitHub Pages deploy_ v3 now use the [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow) instead of a [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) (PAT), and [inputs parameters](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith) instead of environment variables.
8-
>
9-
> If you want to continue using the previous release (with environment variables) you must set the version: [`Cecilapp/GitHub-Pages-deploy@v2`](https://github.com/marketplace/actions/gh-pages-deploy?version=2.0.1).
10-
117
## Usage
128

139
See [action.yml](action.yml).
1410

1511
```yml
1612
- name: Deploy to GitHub Pages
1713
uses: Cecilapp/GitHub-Pages-deploy@v3
18-
env:![badge](https://user-images.githubusercontent.com/80580/188000416-327192fc-4f0f-468f-b619-ad426c58b2a8.svg)
19-
14+
env:
2015
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2116
with:
2217
@@ -27,36 +22,41 @@ See [action.yml](action.yml).
2722
commit_message: custom message # optional
2823
```
2924
30-
**Workflow example:**
25+
### v2 VS v3
26+
27+
> _GitHub Pages deploy_ v3 use the [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow) instead of a [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) (PAT), and [inputs parameters](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith) instead of environment variables.
28+
> If you want to continue using the previous release (with environment variables) you must set the version: [`Cecilapp/GitHub-Pages-deploy@v2`](https://github.com/marketplace/actions/gh-pages-deploy?version=2.0.1).
29+
30+
### Workflow example
3131

3232
```yml
3333
name: GitHub Pages deploy
3434
on:
3535
push:
3636
branches:
37-
- master
37+
- master
3838
3939
jobs:
4040
build-and-deploy:
4141
runs-on: ubuntu-latest
4242
4343
steps:
44-
- name: Checkout
45-
uses: actions/checkout@v2
46-
47-
- name: Build
48-
uses: # build your static site
49-
50-
- name: Deploy to GitHub Pages
51-
uses: Cecilapp/GitHub-Pages-deploy@v3
52-
env:
53-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
54-
with:
55-
56-
build_dir: _site
44+
- name: Checkout
45+
uses: actions/checkout@v3
46+
47+
- name: Build
48+
uses: # build your static site
49+
50+
- name: Deploy to GitHub Pages
51+
uses: Cecilapp/GitHub-Pages-deploy@v3
52+
env:
53+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
54+
with:
55+
56+
build_dir: _site
5757
```
5858

59-
## Note about user and organization sites
59+
## About _user_ and _organization_ sites
6060

6161
> The default publishing source for user and organization sites is the root of the default branch for the repository.
6262

0 commit comments

Comments
 (0)