[
https://issues.apache.org/jira/browse/CB-13828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16373425#comment-16373425
]
ASF GitHub Bot commented on CB-13828:
-------------------------------------
stevengill commented on a change in pull request #170: CB-13828: Improve
cordova-coho/docs
URL: https://github.com/apache/cordova-coho/pull/170#discussion_r169823843
##########
File path: docs/platforms-release-process.md
##########
@@ -19,43 +19,113 @@
#
-->
-# Release Process for ''Platforms Releases''
-
-Before cutting any releases, read the Apache's [Releases
Policy](http://www.apache.org/dev/release)
-
-This page describes the technical steps for releasing a `Platforms Release`
(see: [versioning-and-release-strategy.md](versioning-and-release-strategy.md)).
-
-TODO: We may want to be using [signed
tags](http://git-scm.com/book/en/Git-Basics-Tagging), or at least annotated
tags.
-
-Replace `Android` with the platform you are releasing.
-
-## Get Buy-in
+# Release Process for Cordova Platforms
+
+This page describes the technical steps for doing a `Platforms Release`.
+
+It describes the following steps:
+
+- [General instructions](#general-instructions)
+ * [Repository setup](#repository-setup)
+- [Before you start](#before-you-start)
+ * [Get Buy-in](#get-buy-in)
+ * [Create JIRA issue](#create-jira-issue)
+- [Before Release](#before-release)
+ * [Update and Pin Dependencies](#update-and-pin-dependencies)
+ * [License Check](#license-check)
+- [Prepare Release](#prepare-release)
+ * [Remove the `-dev` suffix from
version](#remove-the--dev-suffix-from-version)
+ * [Increase version](#increase-version)
+ * [Create Release Notes](#create-release-notes)
+ * [Commit Version and Release Notes](#commit-version-and-release-notes)
+ * [Special Case 1: Release notes in release branch for patch
release](#special-case-1-release-notes-in-release-branch-for-patch-release)
+ * [Special Case 2: releasing new commits from an already-existing release
branch](#special-case-2-releasing-new-commits-from-an-already-existing-release-branch)
+ * [Create Release Branch](#create-release-branch)
+- [Testing](#testing)
+ * [1) Plugin tests with `cordova-mobile-spec`
project](#1-plugin-tests-with-cordova-mobile-spec-project)
+ * [2) hello world app with `cordova`
CLI](#2-hello-world-app-with-cordova-cli)
+ * [3) `/bin` scripts](#3-bin-scripts)
+ * [4) `cordova-lib` tests](#4-cordova-lib-tests)
+ * [5) Clean up](#5-clean-up)
+ * [Android Extras](#android-extras)
+ * [iOS Extras](#ios-extras)
+ * [When a regression is found](#when-a-regression-is-found)
+ * [To submit a fix](#to-submit-a-fix)
+- [Push Changes](#push-changes)
+ * [Push commits](#push-commits)
+ * [Tag and push tag](#tag-and-push-tag)
+- [Publish Release Candidate to
`dist/dev`](#publish-release-candidate-to-distdev)
+- [Documentation and Communication](#documentation-and-communication)
+ * [Documentation To Update](#documentation-to-update)
+ * [Prepare Blog Post](#prepare-blog-post)
+- [Voting and Release](#voting-and-release)
+ * [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)
+ * [(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)
+ * [Tell Apache about Release](#tell-apache-about-release)
+ * [Email a release announcement to the mailing
list](#email-a-release-announcement-to-the-mailing-list)
+ * [Announce It!](#announce-it)
+ * [Close JIRA issue](#close-jira-issue)
+ * [Finally](#finally)
+- [Other stuff that should be reviewed and moved up to the appropriate
places](#other-stuff-that-should-be-reviewed-and-moved-up-to-the-appropriate-places)
+ * [Update the Docs](#update-the-docs)
+ * [Moving Tags](#moving-tags)
+
+<!-- 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
+
+- See:
[versioning-and-release-strategy.md](versioning-and-release-strategy.md) for
general versioning information
+- Before cutting any releases, read the Apache's [Releases
Policy](http://www.apache.org/dev/release)
+- Replace `Android` with the platform you are releasing in the instructions
below.
+
+### Repository setup
+
+You should have your platform repository checked out in a folder where you als
ohave checked out all/most/some of the other Cordova repositories. If you
followed the [Cloning/Updating Cordova repositories
Review comment:
spelling: also have*
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Improve cordova-coho/docs
> -------------------------
>
> Key: CB-13828
> URL: https://issues.apache.org/jira/browse/CB-13828
> Project: Apache Cordova
> Issue Type: Improvement
> Components: cordova-coho
> Reporter: Jan Piotrowski (Sujan)
> Priority: Major
>
> /docs in the `cordova-coho` repo is effectively the contributor documentation
> of Cordova. It could use some improvements right now.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
