-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CMS-1033] Add GH action for deployments to wp.org (#219)
* Cleanup distignore, add GH action * Add assets * Add CONTRIBUTING.md, update readmes
- Loading branch information
John Spellman
authored
Nov 22, 2022
1 parent
0ea29b8
commit e3aab31
Showing
9 changed files
with
61 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,27 @@ | ||
# A set of files you probably don't want in your WordPress.org distribution | ||
.babelrc | ||
.deployignore | ||
.circleci | ||
.distignore | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc | ||
.git | ||
.github | ||
.gitignore | ||
.gitlab-ci.yml | ||
.travis.yml | ||
.DS_Store | ||
Thumbs.db | ||
behat.yml | ||
bitbucket-pipelines.yml | ||
bin | ||
.circleci/config.yml | ||
behat.yml | ||
CODEOWNERS | ||
composer.json | ||
composer.lock | ||
dependencies.yml | ||
CONTRIBUTING.md | ||
Gruntfile.js | ||
package.json | ||
package-lock.json | ||
phpunit.xml | ||
phpunit.xml.dist | ||
multisite.xml | ||
multisite.xml.dist | ||
.phpcs.xml | ||
phpcs.xml | ||
.phpcs.xml.dist | ||
phpcs.xml.dist | ||
phpunit.xml.dist | ||
README.md | ||
webpack.config.js | ||
wp-cli.local.yml | ||
yarn.lock | ||
tests | ||
vendor | ||
node_modules | ||
*.sql | ||
*.tar.gz | ||
*.zip | ||
*.zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
name: Release wp-native-php-sessions plugin to wp.org | ||
on: | ||
release: | ||
types: [published] | ||
|
||
jobs: | ||
release: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: WordPress Plugin Deploy | ||
uses: 10up/[email protected] | ||
env: | ||
SVN_USERNAME: ${{ secrets.SVN_USERNAME }} | ||
SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} | ||
SLUG: ${{ env.SLUG }} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Contributing | ||
|
||
The best way to contribute to the development of this plugin is by participating on the GitHub project: | ||
|
||
https://github.com/pantheon-systems/wp-native-php-sessions | ||
|
||
Pull requests and issues are welcome! | ||
|
||
## Testing | ||
|
||
You may notice there are two sets of tests running, on two different services: | ||
|
||
* The [PHPUnit](https://phpunit.de/) test suite. | ||
* The [Behat](http://behat.org/) test suite runs against a Pantheon site, to ensure the plugin's compatibility with the Pantheon platform. | ||
|
||
Both of these test suites can be run locally, with a varying amount of setup. | ||
|
||
PHPUnit requires the [WordPress PHPUnit test suite](https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/), and access to a database with name `wordpress_test`. If you haven't already configured the test suite locally, you can run `bash bin/install-wp-tests.sh wordpress_test root '' localhost`. | ||
|
||
Behat requires a Pantheon site. Once you've created the site, you'll need [install Terminus](https://github.com/pantheon-systems/terminus#installation), and set the `TERMINUS_TOKEN`, `TERMINUS_SITE`, and `TERMINUS_ENV` environment variables. Then, you can run `./bin/behat-prepare.sh` to prepare the site for the test suite. | ||
|
||
## Workflow | ||
|
||
The `develop` branch is the development branch which means it contains the next version to be released. `main` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`. | ||
|
||
## Release Process | ||
|
||
1. Starting from `develop`, cut a release branch named `release_X.Y.Z` containing your changes. | ||
1. Update plugin version in `package.json`, `README.md`, `readme.txt`, and `wp-native-php-sessions.php`. | ||
1. Update the Changelog with the latest changes. | ||
1. Create a PR against the `main` branch. | ||
1. After all tests pass and you have received approval from a CODEOWNER (including resolving any merge conflicts), merge the PR into `main`. | ||
1. Pull `main` locally, create a new tag, and push up. | ||
1. Confirm that the necessary assets are present in the newly created tag, and test on a WP install if desired. | ||
1. Create a [new release](https://github.com/pantheon-systems/wp-native-php-sessions/releases/new) using the tag created in the previous steps, naming the release with the new version number, and targeting the tag created in the previous step. Paste the release changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues if applicable. | ||
1. Wait for the [_Release wp-native-php-sessions plugin to wp.org_ action](https://github.com/pantheon-systems/wp-native-php-sessions/actions/workflows/wordpress-plugin-deploy.yml) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes. | ||
1. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/wp-native-php-sessions/. This may take a few minutes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters