This is an automated email from the ASF dual-hosted git repository. janpio pushed a commit to branch janpio-platform_release_jira in repository https://gitbox.apache.org/repos/asf/cordova-coho.git
commit d3786994c22b9ef7d93627372b6a557a71da9002 Author: Jan Piotrowski <[email protected]> AuthorDate: Thu May 23 19:22:35 2019 +0200 unrelated cleanup --- docs/platforms-release-process.md | 45 +++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/docs/platforms-release-process.md b/docs/platforms-release-process.md index 0117b2f..d01007a 100644 --- a/docs/platforms-release-process.md +++ b/docs/platforms-release-process.md @@ -21,23 +21,21 @@ # Release Process for Cordova Platforms -This page describes the technical steps for doing a `Platforms Release`. +This page describes the technical steps for doing a Platforms Release. ## Table of contents -It describes the following steps: - - [General instructions](#general-instructions) * [Read first](#read-first) * [Repository setup](#repository-setup) - [Before you start](#before-you-start) - * [Read through Apache release policy](#read-through-apache-release-policy) * [Choose a Release Identifier](#choose-a-release-identifier) * [Request buy-in](#request-buy-in) - [Before Release](#before-release) - * [npm audit check](#npm-audit-check) + * [Make sure you're up-to-date](#make-sure-youre-up-to-date) * [Check dependencies](#check-dependencies) - * [Resolve any outdated dependencies](#resolve-any-outdated-dependencies) + - [Resolve any outdated dependencies](#resolve-any-outdated-dependencies) + * [`npm audit` check](#npm-audit-check) * [License Check](#license-check) - [Prepare Release](#prepare-release) * [Optional: Set release version in `package.json`](#optional-set-release-version-in-packagejson) @@ -56,7 +54,7 @@ It describes the following steps: * [4) `cordova-lib` tests](#4-cordova-lib-tests) * [5) Clean up](#5-clean-up) * [When a regression is found](#when-a-regression-is-found) - * [To submit a fix](#to-submit-a-fix) + - [To submit a fix](#to-submit-a-fix) - [Push Changes](#push-changes) * [Push commits](#push-commits) * [Tag and push tag](#tag-and-push-tag) @@ -68,7 +66,7 @@ It describes the following steps: * [Start VOTE Thread](#start-vote-thread) * [Email the result of the vote](#email-the-result-of-the-vote) * [If the Vote does *not* Pass](#if-the-vote-does-not-pass) - * [Otherwise: Publish real release to `dist/` & npm](#otherwise-publish-real-release-to-dist--npm) + * [Otherwise: Publish release to `dist/` & npm](#otherwise-publish-release-to-dist--npm) * [(Android only) Uploading to Bintray](#android-only-uploading-to-bintray) * [Add permanent Apache release tag to repository](#add-permanent-apache-release-tag-to-repository) - [Follow up steps](#follow-up-steps) @@ -82,7 +80,6 @@ It describes the following steps: <!-- created with https://ecotrust-canada.github.io/markdown-toc/ and some manual fixing --> -(Yes this list is long and scary, but represents the content below) ## General instructions @@ -97,11 +94,10 @@ It describes the following steps: You should have your platform repository checked out in a folder where you also have checked out all/most/some of the other Cordova repositories. If you followed the [Cloning/Updating Cordova repositories ](../README.md#cloningupdating-cordova-repositories) instructions of `cordova-coho`, this should already be the case. + ## Before you start -### Read through Apache release policy -Read through the [Apache Releases Policy](http://www.apache.org/dev/release) as stated above. ### Choose a Release Identifier Releases are identified by a "Release Identifier" that is used in commit messages and for temporary folders. @@ -132,27 +128,24 @@ Double check you replace "Android" in the subject and mail body - there is no un Note that it would be possible to continue with some of the [Before Release](#before-release) items while waiting for a possible response. + ## Before Release -### npm audit check +### Make sure you're up-to-date -Ensure that the latest version of npm is installed (using a command such as `npm i npm@latest`), `package-lock.json` is present (do `npm i --package-lock-only` if needed), and then check: +Ensure your checkout of the repository is up-to-date: - (cd cordova-android && npm audit) + coho repo-update -r android # updates the repos ### Check dependencies -Ensure your checkout of the repository is up-to-date: - - coho repo-update -r android - See if any dependencies are outdated (cd cordova-android && npm outdated --depth=0) (The `--depth=0` prevents from listing dependencies of dependencies.) -### Resolve any outdated dependencies +#### Resolve any outdated dependencies **Alternative 1:** @@ -163,6 +156,14 @@ See if any dependencies are outdated Within a new Pull Request: update any outdated dependencies in the project's `package.json` file. Be sure to run through the test section below for compatibility issues. +### `npm audit` check + +Ensure that the latest version of npm is installed (using a command such as `npm i npm@latest`), `package-lock.json` is present (do `npm i --package-lock-only` if needed), and then check: + + (cd cordova-android && npm audit) + +TODO Get rid of package-lock.json afterwards + ### License Check Ensure license headers are present everywhere. For reference, see this [background](http://www.apache.org/legal/src-headers.html). Expect some noise in the output, for example some files from test fixtures will show up. @@ -207,6 +208,7 @@ Update the repos `RELEASENOTES.md` file with changes since the last release. coho update-release-notes -r android (`--from-tag` and/or `--to-tag` may be needed in case of non-master branch) +TODO what does that mean? Examples. Then curate: @@ -320,7 +322,7 @@ rm -rf androidTest* Create an issue for it and fix it via a Pull Request before continuing. -### To submit a fix +#### To submit a fix git checkout master git commit -am 'Your commit message' @@ -466,10 +468,11 @@ _Note: list of PMC members: http://people.apache.org/phonebook.html?pmc=cordova_ * Revert adding of `-dev` * Address the concerns * Re-tag release using `git tag -f` +TODO this seems to be missing a few steps here * Add back `-dev` * Start a new vote -### Otherwise: Publish real release to `dist/` & npm +### Otherwise: Publish release to `dist/` & npm First move the release package files to `dist/`: --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
