Skip to content

Development Workflow

Jump to bottom
Max Saperstone edited this page Jun 29, 2019 · 14 revisions

Branch/Merge Strategy

All work will be done on feature branches. Try to name your feature branch something specific. These should all be branched from develop (set as the default branch in Github). Once the work is completed, push updates to the remote. If an open issue exists on Github, be sure to tie the commit or branch to this issue.

Pull Requests

Submit a pull request from your branch into develop, and assign it to either mgrasberger or msaperst. CI will automatically kick off to run all unit and integration tests, along with scanning the code for known issues. Once enough issues have been fixed, a release will be made.

Snapshots

After feature branch has been merged into develop branch, deploy needs to be done to the snapshot repository.

  • Ensure the correct version is set to the pom, and that it is a snapshot
  • Run the maven deploy goal mvn clean deploy

Javadocs

Javadocs are hosted for the master branch on github.io. Ensure the /docs folder is checked in with changes to the develop folder. When a release is performed, merge these into master, and github will automatically update the javadocs

Versioning

We are using SemVer (Semantic Versioning) for our version tracking.

  • Major version keeps in sync with Selenium major version
  • Minor version increments for added functionality that has incompatible changes
  • Point version increments for added functionality in a backwards-compatible manner

Release

When ready for a full release, follow the below flow:

  1. Release Code
    1. Develop needs to be merged into master
      1. Create a release branch off develop
      2. Ensure the correct version is set in the pom, and that it is a not a snapshot
      3. Generate the javadocs
      4. Merge release branch into master
    2. Run the maven deploy goal
    3. Log in to Sonatype
    4. Search for selenified, and select release
  2. Add Release to GitHub releases page
  3. Update release information on Coveros site Selenified Information
  4. Update download information on Coveros Selenified Contact page

Hotfixes

© Coveros 2019

Clone this wiki locally