Skip to content

Update a plugin readme/assets on the WordPress repository#

The WordPress repository page uses a number of different assets (banner, logo, screenshots) and the content of the readme.txt file to populate the content of the page.

Since it is not necessary to update the plugin to do modifications to these files, the best way to manage them is through a specific Github workflow.

Thankfully, 10up provides to the community a Github action made specifically for this task.

Below is an example workflow to add to your Github repository, under .github/workflows.

name: Plugin assets/readme update
on:
  push:
    branches:
    - main
jobs:
  assets-update:
    name: Assets/readme update
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v6

    - name: WordPress.org plugin asset/readme update
      uses: 10up/action-wordpress-plugin-asset-update@stable
      env:
        SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
        SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
        IGNORE_OTHER_FILES: true

Things to know#

Trigger#

In this example, the workflow is triggered when pushing to the main branch.

Where to store assets#

Assets should be stored in a directory named .wordpress-org. They follow specific naming convention and image format, that can be found in details on this page: https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/

Updating the tested up to value#

This field is part of the readme.txt file, and is used by the repository to indicate which WordPress version the plugin is compatible with. You can update just this value, without releasing a new plugin version, at any time.