Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (49 loc) · 5.18 KB

CONTRIBUTING.md

File metadata and controls

63 lines (49 loc) · 5.18 KB

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-saml-auth

Pull requests and issues are welcome!

Workflow

The main branch is the development branch which means it contains the next version to be released. release contains the corresponding stable development version. Always work on the main branch and open up PRs against main.

We prefer to squash commits (i.e. avoid merge PRs) from a feature branch into main when merging, and to include the PR # in the commit message. PRs to main should also include any relevent updates to the changelog in readme.txt. For example, if a feature constitutes a minor or major version bump, that version update should be discussed and made as part of approving and merging the feature into main. We do not update the README changelogs for development or process related PRs (i.e. dev-only dependencies, or changes to CI patterns unrelated to new features).

Testing

You may notice there are two sets of tests running, on two different services:

  • Travis CI runs the PHPUnit test suite, which mocks interactions with SimpleSAMLphp.
  • Circle CI runs the Behat test suite against a Pantheon site, to ensure the plugin's compatibility with the Pantheon platform. This includes configuring a fully-functional instance of SimpleSAMLphp.

Both of these test suites can be run locally, with a varying amount of setup.

PHPUnit requires the WordPress PHPUnit test suite, 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, 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.

Release Process

  1. Merge your feature branch into main with a PR. This PR should include any necessary updates to the changelog in readme.txt and README.md. Features should be squash merged.
  2. From main, checkout a new branch release_X.Y.Z.
  3. Make a release commit:
    • In package.json, README.md, readme.txt, and wp-saml-auth.php, remove the -dev from the version number.
    • For the README files, the version number must be updated both at the top of the document as well as the changelog.
    • Add the date to the ** X.Y.Z ** heading in the changelogs in README.md, readme.txt, and any other appropriate location.
    • Commit these changes with the message Release X.Y.Z
    • Push the release branch up.
  4. Open a Pull Request to merge release_X.Y.Z into release. Your PR should consist of all commits to main since the last release, and one commit to update the version number. The PR name should also be Release X.Y.Z.
  5. After all tests pass and you have received approval from a CODEOWNER (including resolving any merge conflicts), merge the PR into release. Use a "merge" commit, do no not rebase or squash. If the GitHub UI doesn't offer a "Merge commit" option (only showing "Squash and merge" or "Rebase and merge"), merge from the terminal instead: git checkout release git merge release_X.Y.Z git push origin release
  6. After merging to the release branch, a draft Release will be automatically created by the build-tag-release workflow. This draft release will be automatically pre-filled with release notes.
  7. Confirm that the necessary assets are present in the newly created tag, and test on a WP install if desired.
  8. Review the release notes, making any necessary changes, and publish the release.
  9. Wait for the Release to wp.org action to finish deploying to the WordPress.org plugin repository.
  10. If all goes well, users with SVN commit access for that plugin will receive an email with a diff of the changes.
  11. Check WordPress.org: Ensure that the changes are live on the plugin repository. This may take a few minutes.
  12. Following the release, prepare the next dev version with the following steps:
    • git checkout release
    • git pull origin release
    • git checkout main
    • git rebase release
    • Update the version number in all locations, incrementing the version by one patch version, and add the -dev flag (e.g. after releasing 1.2.3, the new verison will be 1.2.4-dev)
    • Add a new ** X.Y.Z-dev ** heading to the changelog
    • git add -A .
    • git commit -m "Prepare X.Y.Z-dev"
    • git checkout -b release-XYZ-dev
    • git push origin release-XYZ-dev
    • Create a pull request on GitHub UI from release-XYZ-dev to main to trigger all required status checks
    • Wait for all required status checks to pass in CI. Once all tests pass, push to main from the terminal:
    • git checkout main && git push origin main
    • Note: While main is typically protected, having an open PR with passing tests allows direct push to main, which is the preferred method here.