Skip to content

Commit bdec8f0

Browse files
helenJasonTheAdams
authored andcommitted
Update readme to document input/output params
1 parent 221c2e4 commit bdec8f0

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ This Action commits the contents of your Git tag to the WordPress.org plugin rep
1717
* `VERSION` - defaults to the tag name; do not recommend setting this except for testing purposes.
1818
* `ASSETS_DIR` - defaults to `.wordpress-org`, customizable for other locations of WordPress.org plugin repository-specific assets that belong in the top-level `assets` directory (the one on the same level as `trunk`).
1919

20+
### Inputs
21+
* `generate-zip` - Generate a ZIP file from the SVN `trunk` directory. Outputs a `zip-path` variable for use in further workflow steps. Defaults to false.
22+
23+
### Outputs
24+
* `zip-path` - The path to the ZIP file generated if `generate-zip` is set to `true`. Fully qualified including the filename, intended for use in further workflow steps such as uploading release assets.
25+
2026
## Excluding files from deployment
2127
If there are files or directories to be excluded from deployment, such as tests or editor config files, they can be specified in either a `.distignore` file or a `.gitattributes` file using the `export-ignore` directive. If a `.distignore` file is present, it will be used; if not, the Action will look for a `.gitattributes` file and barring that, will write a basic temporary `.gitattributes` into place before proceeding so that no Git/GitHub-specific files are included.
2228

@@ -112,7 +118,7 @@ jobs:
112118
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
113119
with:
114120
upload_url: ${{ github.event.release.upload_url }}
115-
asset_path: ${{github.workspace}}/${{ github.event.repository.name }}.zip
121+
asset_path: ${{ steps.deploy.outputs.zip-path }}
116122
asset_name: ${{ github.event.repository.name }}.zip
117123
asset_content_type: application/zip
118124
```

0 commit comments

Comments
 (0)