Skip to content

Commit

Permalink
few tweaks and clarifications to release documentation (#3020)
Browse files Browse the repository at this point in the history
* few tweaks and clarifications to release documentation

* added release template to release instructions

* fix formatting

* fix formatting
  • Loading branch information
snapwich authored and mkendall07 committed Aug 24, 2018
1 parent bf3beef commit ce1ea59
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions RELEASE_SCHEDULE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,17 @@ Announcements regarding releases will be made to the #headerbidding-dev channel

## Release Process

_Note: If `github.com/prebid/Prebid.js` is not configured as the git origin for your repo, all of the following git commands will have to be modified to reference the proper remote (e.g. `upstream`)_

1. Make Sure all browserstack tests are passing. On PR merge to master CircleCI will run unit tests on browserstack. Checking the last CircleCI build [here](https://circleci.com/gh/prebid) for master branch will show you detailed results.

In case of failure do following,
- Try to fix the failing tests.
- If you are not able to fix tests in time. Skip the test, create issue and tag contributor.

#### How to run tests in browserstack

_Note: the following browserstack information is only relevant for debugging purposes, if you will not be debugging then it can be skipped._

Set the environment variables. You may want to add these to your `~/.bashrc` for convenience.

Expand Down Expand Up @@ -59,11 +63,12 @@ Announcements regarding releases will be made to the #headerbidding-dev channel
Pull these changes locally by running command
```
git pull
git fetch --tags
```

and verify the tag.

5. Update coveralls
5. Update coveralls _(skip for legacy)_

We use https://coveralls.io/ to show parts of code covered by unit tests.

Expand All @@ -75,22 +80,35 @@ Announcements regarding releases will be made to the #headerbidding-dev channel

Run `gulp coveralls` to update code coverage history.

6. Distribute the code
6. Distribute the code

_Note: do not go to step 7 until step 6 has been verified completed._

Reach out to any of the Appnexus folks to trigger the jenkins job.

// TODO
Jenkins job is moving files to appnexus cdn, pushing prebid.js to npm, purging cache and sending notification to slack.
Move all the files from Appnexus CDN to jsDelivr and create bash script to do above tasks.

7. Post Release Steps
7. Post Release Version

Update the version
Manually edit Prebid's package.json to become "1.x.x-pre" (using the values for the next release). Then commit your changes.
```
git commit -m "Increment pre version"
git push
```

8. Create new release draft

Go to [github releases](https://github.com/prebid/Prebid.js/releases) and add a new draft for the next version of Prebid.js with the following template:
```
## 🚀New Features
## 🛠Maintenance
## 🐛Bug Fixes
```

## Beta Releases

Expand Down

0 comments on commit ce1ea59

Please sign in to comment.