https://github.com/pronamic/action-wordpress-org-plugin-deploy

Deploy your WordPress plugin file in the WordPress.org plugin directory with this GitHub action.
https://github.com/pronamic/action-wordpress-org-plugin-deploy

deploy deployment github github-actions pronamic release release-automation subversion svn wordpress wordpress-development wordpress-org wordpress-plugin

Last synced: 7 months ago
JSON representation

Deploy your WordPress plugin file in the WordPress.org plugin directory with this GitHub action.

• Host: GitHub
• URL: https://github.com/pronamic/action-wordpress-org-plugin-deploy
• Owner: pronamic
• Created: 2024-08-02T10:27:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-05T08:56:42.000Z (8 months ago)
• Last Synced: 2025-06-05T09:40:57.000Z (8 months ago)
• Topics: deploy, deployment, github, github-actions, pronamic, release, release-automation, subversion, svn, wordpress, wordpress-development, wordpress-org, wordpress-plugin
• Language: PHP
• Homepage:
• Size: 153 KB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Github action WordPress.org deploy

## Introduction

### Streamline your WordPress plugin deployment

This GitHub action simplifies deploying your WordPress plugin directly in the WordPress plugin directory.

### Built for WordPress developers

Leveraging PHP instead of bash scripting, this action caters to the preferences of many WordPress developers, offering a familiar and potentially more convenient workflow.

## Usage

This GitHub action can be used to automatically deploy a WordPress plugin to the WordPress.org plugin directory whenever a new release is released via GitHub releases. It is important that the GitHub release contains a distribution archive asset with a filename of the `{name}.{version}.zip` format. The [WP-CLI command `wp dist-archive`](https://developer.wordpress.org/cli/commands/dist-archive/) can be used to create a distribution archive with this filename format.

### Actions secrets and variables

For the WordPress.org login details it can be useful to create a variable and secret at organization level. For example, for the organization Pronamic the following variable and secret are used:

```

${{ vars.WORDPRESS_ORG_PRONAMIC_USERNAME }}

```

```

${{ secrets.WORDPRESS_ORG_PRONAMIC_PASSWORD }}

```

This way, the WordPress login details can be managed in one place and you don't have to do this per repository or environment.

#### Screenshot of GitHub organization actions variables settings

![Screenshot of GitHub organization actions variables settings.](documentation/github.com_organizations_pronamic_settings_variables.png)

#### Screenshot of GitHub organization actions secrets settings

![Screenshot of GitHub organization actions secrets settings.](documentation/github.com_organizations_pronamic_settings_secrets.png)

### Environments

The WordPress.org plugin directory can be seen as an environment where the plugin in a GitHub repository can be deployed to. The advantage of this is that GitHub shows the deployments to the WordPress.org plugin directory. And with protection rules you can delay the deployment to WordPres.org until after approval by 1 or more GitHub users.

#### Screenshot of GitHub repository environments settings

![Screenshot of GitHub repository environments settings.](documentation/github.com_pronamic_wp-salesfeed_settings_environments.png)

#### Screenshot of GitHub repository homepage deployments



#### Screenshot of GitHub repository environment deployment protection rules

![Screenshot of GitHub repository environment deployment protection rules.](documentation/github.com_pronamic_wp-salesfeed_settings_environments_deployment-protection-rules.png)

## Example

```yml

name: Deploy to WordPress.org

on:

  workflow_dispatch:

    inputs:

      tag:

        description: 'Tag to deploy to WordPress.org'

        required: true

        type: string

  release:

    types: [released]

jobs:

  deploy:

    runs-on: ubuntu-latest

    environment:

      name: WordPress.org plugin directory

      url: https://wordpress.org/plugins/salesfeed/

    steps:

      - name: Deploy

        uses: pronamic/action-wordpress-org-plugin-deploy@main

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

        with:

          username: ${{ vars.WORDPRESS_ORG_PRONAMIC_USERNAME }}

          password: ${{ secrets.WORDPRESS_ORG_PRONAMIC_PASSWORD }}

          tag: ${{ inputs.tag || github.event.release.tag_name }}

          slug: salesfeed

```

## Inspiration

- https://github.com/marketplace/actions/wordpress-plugin-svn-deploy

  - https://github.com/nk-o/action-wordpress-plugin-deploy

- https://github.com/marketplace/actions/wordpress-plugin-readme-assets-update

  - https://github.com/10up/action-wordpress-plugin-asset-update

- https://github.com/marketplace/actions/deploy-to-wordpress-org-svn-repository

  - https://github.com/richard-muvirimi/deploy-wordpress-plugin

- https://github.com/actions/deploy-pages

- https://github.com/actions/upload-pages-artifact

## Development

```

GITHUB_REPOSITORY=pronamic/pronamic-pay-with-rabo-smart-pay-for-woocommerce php release.php

```