Skip to content

Commit 6107155

Browse files
committed
Another round of docs.
1 parent cfc05f0 commit 6107155

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

readme.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Within the GitHub Actions workflow which deploys your plugin to WordPress.org:
3838
```
3939
4040
> [!WARNING]
41-
> In order to support plugin release confirmation, which is a manual step, this action will attempt to fetch the zip file from WordPress.org for up to 60 minutes. You can adjust this via the `timeout` input parameter.
41+
> In order to support [plugin release confirmation](https://developer.wordpress.org/plugins/wordpress-org/release-confirmation-emails/) this action will attempt to fetch the zip file from WordPress.org for up to 60 minutes. You can adjust this via the `timeout` input parameter.
4242

4343
## Example workflow
4444

@@ -76,9 +76,7 @@ This action is specifically for generating an artifact attestation for the ZIP f
7676

7777
## Does this work if release confirmation is enabled?
7878

79-
The plugin directory on WordPress.org provides a feature called [Release Confirmation](https://developer.wordpress.org/plugins/wordpress-org/release-confirmation-emails/).
80-
81-
This action supports release confirmation because it is designed to retry fetching the plugin ZIP from WordPress.org for up to 60 minutes by default, which allows you time to confirm the release.
79+
Yes, this action supports [plugin release confirmation](https://developer.wordpress.org/plugins/wordpress-org/release-confirmation-emails/) because it will repeatedly attempt to fetch the plugin ZIP from WordPress.org for up to 60 minutes by default, which allows you time to confirm the release.
8280

8381
## Tip
8482

@@ -95,16 +93,32 @@ wget https://downloads.wordpress.org/plugin/query-monitor.3.16.4.zip
9593
gh attestation verify query-monitor.3.16.4.zip --repo johnbillion/query-monitor
9694
```
9795

96+
## How can I test this action without doing a release?
97+
98+
Add the steps to a `workflow_dispatch` workflow that checks out a tag, zips it up, and then runs it. You can use the 10up WordPress.org Plugin Deploy action with the `dry-run` input parameter to get the ZIP file path.
99+
100+
Optionally use the `dry-run` input parameter for this action to perform all the steps without actually creating and publishing the attestation.
101+
102+
## How do I re-run attestation if the action times out before I confirm the release on WordPress.org?
103+
104+
See above.
105+
98106
## Where can I see the attestations for my plugin?
99107

100-
The action will output a link to the attestation within your repo.
108+
The action will output a link to the attestation.
101109

102-
You can also view all the attestations from the Attestations link on the Actions screen of your repo.
110+
You can also view all attestations from the Actions -> Attestations screen in your repo.
103111

104112
## Can I call this action within a reusable workflow?
105113

106114
Yes, but be aware that when a consumer verifies an attestation they need to use the name of the repo containing the workflow file that performed the attestation. If the reusable workflow is in the same repo as your plugin then there's no problem, but if your reusable workflow lives in a different repo then they'll need to use the name of that repo.
107115

116+
## TODO
117+
118+
* Make the `version` input parameter optional
119+
* Add support for arbitrary remote hosts in addition to wordpress.org
120+
* Consider how attestations can be used as part of workflows for installing and deploying plugins
121+
108122
## License
109123

110124
MIT

0 commit comments

Comments
 (0)