CB-13828: Improve cordova-coho/docs #170
Conversation
- Better headlines and grouping - Add missing files that were not linked before - Short introduction
janpio
changed the title
janpio
changed the title
docs/platforms-release-process.md
Outdated
|
|
||
| ### 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 |
docs/platforms-release-process.md
Outdated
|
|
||
| If the changes merit it, manually bump the major / minor/ patch version in `package.json`. View the changes via: | ||
| Note: In `cordova-android`, also remember to handle the version in `framework/build.gradle`. |
There was a problem hiding this comment.
169 can actually be removed. coho prepare-release-branch command that is run later will update build.gradle
There was a problem hiding this comment.
Is this good enough? I was somehow thinking there was a reason that "remove -dev" and the other version stuff later is split in 2 parts?
There was a problem hiding this comment.
The remove dev part is split from the other version stuff because we use the version you set in package.json when writing to releasenotes. After you remove dev you may manually change the versionwhen reviewing commits in case you want a patch/minor/major release. This happens right before we run the update releasenotes command
There was a problem hiding this comment.
Ah, now I finally got it I think. Updated the file to document this in more detail: efe62e3
docs/platforms-release-process.md
Outdated
|
|
||
| for l in cordova-android; do ( cd $l; v="$(grep '"version"' package.json | cut -d'"' -f4)"; if [[ $v = *-dev ]]; then v2="${v%-dev}"; echo "$l: Setting version to $v2"; sed -i '' -E 's/version":.*/version": "'$v2'",/' package.json; fi) ; done | ||
|
|
||
| In `cordova-android`, also remember to bump the version in `framework/build.gradle`. | ||
| Note: This command [doesn't actually work](https://issues.apache.org/jira/browse/CB-13809). You can also replace `-dev` manually of course. |
There was a problem hiding this comment.
Strange, it worked fine for me on this latest android release.
There was a problem hiding this comment.
Yeah, I also felt this was strange as I assumes these were used quite often. You can take a look at the linked issues.
docs/platforms-release-process.md
Outdated
|
|
||
| ( cd cordova-android && git log --pretty=format:'* %s' --topo-order --no-merges $(git describe --tags $(git rev-list --tags --max-count=1))..master ) | ||
|
|
||
| Note: This command [doesn't actually work](https://issues.apache.org/jira/browse/CB-13901). You can also check out the changes manually (or via the next step). |
There was a problem hiding this comment.
once again, worked fine for me for latest android release. A pre-requisite to running this command is making sure you have the latest tags. I had to run git fetch --tags in cordova-android repo to grab the tags I was missing.
There was a problem hiding this comment.
Just noticed that I only ran this on Windows shell, not WSL/bash so this one might actually be just a different in the params of git on Windows.
There was a problem hiding this comment.
Indeed, it works in WSL. Will update the text.
docs/platforms-release-process.md
Outdated
|
|
||
| 1. Creates a release branch `5.0.x` (if it doesn't already exist) | ||
| 2. Updates `cordova.js` snapshot on both `5.0.x` and `master` | ||
| 3. Updates version numbers (`VERSION` files) on `5.0.x` |
There was a problem hiding this comment.
It also updates in other files but that is platform specific. For example, it updates build.gradle version for android. It does similar stuff for iOS.
There was a problem hiding this comment.
Reworded that and added your example.
What does this PR do?
Improve readability of index.md/README.md:
Reworked platforms-release-process.md:
Checklist