└── README.md


/README.md:
--------------------------------------------------------------------------------
 1 | # GitHub Actions Library by rtCamp
 2 | 
 3 | [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 4 | 
 5 | 
 6 | A collection of [GitHub Actions](https://github.com/features/actions) created by rtCamp.
 7 | 
 8 | This repo itself acts as a placeholder only. We have created a separate repo for each GitHub action to make our actions available via GitHub actions marketplace.
 9 | 
10 | ## List of GitHub Actions
11 | 
12 | Please go to individual GitHub action to read more about them, including usage instructions. All our GitHub actions can be used individually or combined on projects according the requirements.
13 | 
14 | A minimal WordPress CI/CD including three actions has been setup on a [skeleton repo](https://github.com/rtCamp/wordpress-skeleton).
15 | 
16 | GitHub Action                                                                     | GitHub Action's Purpose
17 | ----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------
18 | <img src="https://user-images.githubusercontent.com/8456197/54678910-15ecde80-4b2c-11e9-9bda-149b94951de6.png" height="19px">🕵️‍♂️&nbsp;[PHPCS Code Review](https://github.com/rtCamp/action-phpcs-code-review)    | Run PHPCS on pull requests.
19 | <img src="https://wordpress.org/favicon.ico" height="19px">🚀&nbsp;[Deploy WordPress](https://github.com/rtCamp/action-deploy-wordpress)           | Deploy a WordPress site using using PHP's Deployer.org
20 | <img src="https://a.slack-edge.com/cebaa/img/ico/favicon.ico" height="19px">❗&nbsp;[Slack Notify](https://github.com/rtCamp/action-slack-notify)                     | Send a notification to a Slack channel
21 | 
22 | ## Extras
23 | 
24 | ### WordPress Skeleton
25 | 
26 | We follow "One Site, One Repo" approach for all our WordPress projects.
27 | You can check [our wordpress skeleton repo here](https://github.com/rtCamp/wordpress-skeleton).
28 | Some of our actions, such as WordPress Deployer, depends on git repo structure.
29 | 
30 | ### Hashicorp Vault (optional)
31 | 
32 | If you don't use Vault, you can ignore this part. This is completely optional.
33 | 
34 | We use [Hashicorp Vault](https://www.vaultproject.io) internally for secrets management. So all our actions support fetching secrets from Hashicorp Vault, in addition to [GitHub secrets](https://developer.github.com/actions/managing-workflows/storing-secrets/).
35 | 
36 | For some actions such as Slack Notify, Vault may seems redundant. But for other such as [Deploy WordPress](https://github.com/rtCamp/action-deploy-wordpress) action, Vault is time saver. 
37 | 
38 | GitHub doesn't support organization wide secrets. So with GitHub secrets, we need to duplicate many secrets, such as dev/test server SSH keys, across multiple repos.
39 | 
40 | Using Vault, we reduce this effort to setup Vault's token in GitHub secrets. Further, Vault policies help us enforce fine grain control.
41 | 
42 | ## WP Core and Plugins Auto-Update Reporting
43 | 
44 | **PM:** [sohel.mistry@rtcamp.com](mailto:sohel.mistry@rtcamp.com)  
45 | **Devs:** [abhishek.kumar@rtcamp.com](mailto:abhishek.kumar@rtcamp.com)
46 | 
47 | ## Does this interest you?
48 | 
49 | <a href="https://rtcamp.com/"><img src="https://rtcamp.com/wp-content/uploads/sites/2/2019/04/github-banner@2x.png" alt="Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions"></a>
50 | 


--------------------------------------------------------------------------------