Skip to content

Commit 29ff2fa

Browse files
committed
cleanup example references in readme
1 parent 56a23dc commit 29ff2fa

File tree

1 file changed

+6
-63
lines changed

1 file changed

+6
-63
lines changed

README.md

Lines changed: 6 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -71,70 +71,13 @@ If there are files or directories to be excluded from deployment, such as tests
7171

7272
## Example Workflow Files
7373

74-
To get started, you will want to copy the contents of one of these examples into `.github/workflows/deploy.yml` and push that to your repository. You are welcome to name the file something else, but it must be in that directory. The usage of `ubuntu-latest` is recommended for compatibility with required dependencies in this Action.
75-
76-
### Deploy on pushing a new tag
77-
78-
```yml
79-
name: Deploy to WordPress.org
80-
on:
81-
push:
82-
tags:
83-
- "*"
84-
jobs:
85-
tag:
86-
name: New tag
87-
runs-on: ubuntu-latest
88-
steps:
89-
- uses: actions/checkout@master
90-
- name: Build # Remove or modify this step as needed
91-
run: |
92-
npm install
93-
npm run build
94-
- name: WordPress Plugin Deploy
95-
uses: 10up/action-wordpress-plugin-deploy@stable
96-
env:
97-
SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
98-
SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
99-
SLUG: my-super-cool-plugin # optional, remove if GitHub repo name matches SVN slug, including capitalization
100-
```
74+
To get started, you will want to copy the contents of one of [these examples](examples) into `.github/workflows/deploy.yml` and push that to your repository. You are welcome to name the file something else, but it must be in that directory. The usage of `ubuntu-latest` is recommended for compatibility with required dependencies in this Action.
10175

102-
### Deploy on publishing a new release and attach a ZIP file to the release
103-
104-
```yml
105-
name: Deploy to WordPress.org
106-
on:
107-
release:
108-
types: [published]
109-
jobs:
110-
tag:
111-
name: New release
112-
runs-on: ubuntu-latest
113-
steps:
114-
- name: Checkout code
115-
uses: actions/checkout@v2
116-
- name: Build
117-
run: |
118-
npm install
119-
npm run build
120-
- name: WordPress Plugin Deploy
121-
id: deploy
122-
uses: 10up/action-wordpress-plugin-deploy@stable
123-
with:
124-
generate-zip: true
125-
env:
126-
SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
127-
SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
128-
- name: Upload release asset
129-
uses: actions/upload-release-asset@v1
130-
env:
131-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
132-
with:
133-
upload_url: ${{ github.event.release.upload_url }}
134-
asset_path: ${{ steps.deploy.outputs.zip-path }}
135-
asset_name: ${{ github.event.repository.name }}.zip
136-
asset_content_type: application/zip
137-
```
76+
Current set of example workflow files:
77+
78+
* [Deploy on publishing a new release and attach a ZIP file to the release](examples/deploy-on-publishing-a-new-release-and-attach-a-zip-file-to-the-release.yml)
79+
* [Deploy on pushing a new tag](examples/deploy-on-pushing-a-new-tag.yml)
80+
* [Deploy on pushing a new tag and create release with attached ZIP](examples/deploy-on-pushing-a-new-tag-and-create-release-with-attached-zip.yml)
13881

13982
## Contributing
14083

0 commit comments

Comments
 (0)