WordPress Deploy Archive GitHub Action

A custom GitHub Action to deploy a WordPress zip archive or directory (e.g. to a custom WP Update Server) using LFTP

Usage Example

Place the following in /.github/workflows/main.yml

on: push
name: 🚀 Deploy WordPress Plugin on Push
jobs:
  build-deploy:
    name: 🎉 Deploy
    runs-on: ubuntu-latest
    steps:
      - name: 🚚 Checkout latest code
        uses: actions/checkout@v4

      - name: 🚀 Deploy Plugin Dir 
        uses: webshr/action-wp-deploy-archive@latest
        with:
          mode: dir # required; defaults to `zip`
          hostname: your-wp-update-server.com # required
          username: yourFtpUsername # required
          password: ${{ secrets.ftp_password }} # required
          protocol: ftps # required; defaults to ftp
          debug: true # optional; defaults to false
          source-dir: /dist # optional; defaults to `./`
          target-dir: /path/to/directory # optional; defaults to `/`

Excluding files from the directory

You can specify files or directories to be excluded from an archive using a .distignore file. It's recommended to use a .distignore file, especially for built files in .gitignore. The .gitattributes file is useful for projects that don't run a build step and ensures consistency with files committed to WordPress.org.

.gitignore example:

/.wordpress-org
/.git
/node_modules

.distignore
.gitignore

Configuration

Add your keys directly to your .yml configuration file or referenced from the Secrets project store.

It is strongly recommended to save sensive credentials as secrets.

Key Name	Required	Example	Default	Description
mode	yes	file	file	Set mode (zip, file or dir)
hostname	yes	ftp.wpupdate.com		Server hostname
port	no	22	21	Server port
username	yes	username@wpupdate.com		Server username
password	no	${{ secrets.pass }}		Server password
protocol	no	sftp	ftp	FTP Protocol (FTP, FTPS, HTTPS or SFTP)
ssl-auth	no	true	false	SSL Authentication
ssl-force	no	true	false	Force SSL
ssl-protect-data	no	true	false	Protect data with SSL
ssl-key-file	no	true	false	SSL Key File
ssl-verify-cert	no	true	false	Verify SSL certificate
ssl-check-host	no	true	false	Check SSL Hostname
sftp-connect-program	no	"ssh -a -x"	"ssh -a -x"	SFTP Connect Program
file-name	no	.distignore	.distignore	Name of the target file (with extension)
archive-name	no	my-plugin	theme	Name of the target archive (zip only)
source-dir	no	/dist-archive/	./	Path to the local directory (src)
target-dir	no	/web/api/v1/packages	/	Path to the remote directory (dest)
debug	no	true	false	Enable debug mode
chmod	no	u+rwx	false	Set permissions for the uploaded directory
ignore	no	true	false	Exclude files and directories from .distignore
only-newer	no	true	true	Upload only newer files
clean-dir	no	true	false	Clean the remote directory before uploading
auto-confirm	no	true	true	Auto-confirm all SSH questions
max-retries	no	3	3	Maximum number of retries
pre-commands	no	mv /dest/project2 /temp/project2;	""	Commands to run before deploying
post-commands	no	mv /temp/project2 /dest/project2;	""	Commands to run after deploying

Credits

This action is inspired by and builds upon the work done from Drone FTP(S) Plugin

Further Reading

• Custom WP Update Server by Yahnis Elsts
• Offical LFTP manual

License

This action is licensed under the MIT License.