With this GitHub action you can easily deploy your WordPress plugin readme.txt file in the WordPress plugin directory.
This GitHub action simplifies deploying your WordPress plugin's readme.txt file directly in the WordPress plugin directory.
Leveraging PHP instead of bash scripting, this action caters to the preferences of many WordPress developers, offering a familiar and potentially more convenient workflow.
name: Deploy readme.txt to WordPress.org
on:
workflow_dispatch:
jobs:
deploy:
runs-on: ubuntu-latest
environment:
name: WordPress.org plugin directory
url: ${{ steps.deploy.outputs.public-url }}
steps:
- name: Checkout
uses: actions/checkout@v7
with:
sparse-checkout: |
.github
.wordpress-org
readme.txt
- name: Deploy
id: deploy
uses: solvebeam/action-wordpress-plugin-readme-update@main
with:
username: solvebeam
password: ${{ secrets.SVN_PASSWORD }}
slug: solvebeam-diagrams-with-mermaid| Output | Description |
|---|---|
public-url |
Public URL of the plugin on WordPress.org, for example https://wordpress.org/plugins/solvebeam-diagrams-with-mermaid/. |
svn-url |
Subversion repository URL of the plugin, for example https://plugins.svn.wordpress.org/solvebeam-diagrams-with-mermaid. |
svn-tag-url |
Subversion URL of the deployed tag, for example https://plugins.svn.wordpress.org/solvebeam-diagrams-with-mermaid/tags/1.0.0. Empty if readme.txt has no Stable tag. |
After a successful deploy the action adds a job summary to the workflow run, with links to the plugin on WordPress.org, the Subversion repository, Trac and the stable tag, plus a list of the added, modified and removed Subversion paths.
A deploy is essentially a series of shell commands, so the summary also lists every command the action executed, grouped per step. This makes it easier to understand what happens during a deploy, the Subversion password is replaced by ●●●●●●●●.
- https://github.com/marketplace/actions/wordpress-plugin-svn-deploy
- https://github.com/marketplace/actions/wordpress-plugin-readme-assets-update
- https://github.com/marketplace/actions/deploy-to-wordpress-org-svn-repository
SVN_USERNAME=test SVN_PASSWORD=test WP_SLUG=salesfeed php deploy.php