{"id":20164888,"url":"https://github.com/somoscuatro/action-deploy-to-wpengine","last_synced_at":"2025-03-03T03:15:02.290Z","repository":{"id":175237818,"uuid":"653761593","full_name":"somoscuatro/action-deploy-to-wpengine","owner":"somoscuatro","description":"An action to deploy a WordPress project to a WP Engine site via git.","archived":false,"fork":false,"pushed_at":"2024-06-03T13:50:53.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-13T14:32:51.575Z","etag":null,"topics":["actions","deploy-action","deployment","github-actions","wpengine","wpengine-git-push"],"latest_commit_sha":null,"homepage":"https://somoscuatro.es","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/somoscuatro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-14T17:18:55.000Z","updated_at":"2024-06-03T13:54:33.000Z","dependencies_parsed_at":"2024-11-14T00:36:05.882Z","dependency_job_id":"5a1f93ef-c148-419f-bb07-7cb72f9aec29","html_url":"https://github.com/somoscuatro/action-deploy-to-wpengine","commit_stats":null,"previous_names":["somoscuatro/action-deploy-to-wpengine"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somoscuatro%2Faction-deploy-to-wpengine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somoscuatro%2Faction-deploy-to-wpengine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somoscuatro%2Faction-deploy-to-wpengine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/somoscuatro%2Faction-deploy-to-wpengine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/somoscuatro","download_url":"https://codeload.github.com/somoscuatro/action-deploy-to-wpengine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241600490,"owners_count":19988715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","deploy-action","deployment","github-actions","wpengine","wpengine-git-push"],"created_at":"2024-11-14T00:36:00.670Z","updated_at":"2025-03-03T03:15:02.272Z","avatar_url":"https://github.com/somoscuatro.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Action for WP Engine Git Deployments\n\nWelcome to the official repository of the GitHub Action for WP Engine Git\nDeployments. This action allows you to automatically deploy your WordPress\nproject to a [WP Engine](https://wpengine.com/) site via Git.\n\n## Usage\n\n1. Generate an SSH key for authentication between GitHub and WP Engine\n1. Add the public SSH key to your WP Engine website environment: _Sites_ \u003e _Your\n   Website Environment_ \u003e _GitPush_. See [Git Version Control System WP Engine\n   documentation\n   page](https://wpengine.com/support/git?_gl=1*11vkt9z*_ga*OTU0MzU3MTE2OC4xNjgxMjg0Nzc1*_ga_QQ5FN8NX8W*MTcxNzQxOTU0Mi4xMC4xLjE3MTc0MTk3NjQuMC4wLjI5MTg0NDY1MQ..#Create_SSH_Config)\n1. In your GitHub Repository settings, create new Secrets for the SSH Private\n   (`WPENGINE_SSH_PRIVATE_KEY`) and Public keys (`WPENGINE_SSH_PUBLIC_KEY`). See\n   [Adding secrets for a repository\n   documentation](https://wpengine.com/support/git?_gl=1*11vkt9z*_ga*OTU0MzU3MTE2OC4xNjgxMjg0Nzc1*_ga_QQ5FN8NX8W*MTcxNzQxOTU0Mi4xMC4xLjE3MTc0MTk3NjQuMC4wLjI5MTg0NDY1MQ..#Create_SSH_Config)\n1. Create a workflow file in your project repo, for example\n   `.github/workflows/deploy.yml`\n1. Add the following code to the workflow file you just created:\n\n    ```yml\n    name: Deploy to WP Engine\n\n    on:\n      # In this example we are deploying to WP Engine when a new release is published.\n      # You can change this to be on PR merge, push to a given branch, etc.\n      # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows\n      release:\n        types: [published]\n\n    jobs:\n      build:\n        runs-on: ubuntu-latest\n        steps:\n          - uses: actions/checkout@v3\n            name: Checkout repository\n            with:\n              fetch-depth: 0\n\n          # Do your things here.\n          # For example install dependencies, build assets before deploying, etc.\n\n          - name: Deploy\n            uses: somoscuatro/action-deploy-to-wpengine\n            env:\n              WPENGINE_SSH_PRIVATE_KEY: ${{ secrets.WPENGINE_SSH_PRIVATE_KEY }}\n              WPENGINE_SSH_PUBLIC_KEY: ${{ secrets.WPENGINE_SSH_PUBLIC_KEY }}\n              WPENGINE_ENVIRONMENT_NAME: production # Defaults to production. Adjust to match your WP Engine environment name, if needed.\n    ```\n\n1. If you want to exclude some files to be deployed, create a\n   `.github/workflows/deploy/excluded` file in your project repo containing\n   untracked files and folders that WP Engine should ignore. For example:\n\n    ```yml\n    .vscode\n    .docker\n    docker-compose.yml\n    .env\n    ```\n\n## Environment Variables \u0026 Secrets\n\n### Required\n\n| Name                        | Type                 | Required | Usage                                                                           |\n| --------------------------- | -------------------- | -------- | ------------------------------------------------------------------------------- |\n| `WPENGINE_SSH_PRIVATE_KEY`  | Secret               | Yes      | Private SSH key of your WP Engine git deploy user. See below for SSH key usage. |\n| `WPENGINE_SSH_PUBLIC_KEY`   | Secret               | Yes      | Public SSH key of your WP Engine git deploy user. See below for SSH key usage.  |\n| `WPENGINE_ENVIRONMENT_NAME` | Environment Variable | No       | Defaults to `production`.                                                       |\n\n## How to Contribute\n\nAny kind of contribution is very welcome!\n\nPlease, be sure to read our Code of Conduct.\n\nIf you notice something wrong please open an issue or create a Pull Request or\njust send an email to [tech@somoscuatro.es](mailto:tech@somoscuatro.es). If you\nwant to warn us about an important security vulnerability, please read our\nSecurity Policy.\n\n## License\n\nAll code is released under MIT license version. For more information, please\nrefer to\n[LICENSE.md](https://github.com/somoscuatro/action-deploy-to-wpengine/blob/main/LICENSE)\nfile.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsomoscuatro%2Faction-deploy-to-wpengine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsomoscuatro%2Faction-deploy-to-wpengine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsomoscuatro%2Faction-deploy-to-wpengine/lists"}