From 9bd6158292374fc6dd5f7eba33e7586ca1d76177 Mon Sep 17 00:00:00 2001 From: Langston Smith Date: Tue, 8 Oct 2019 12:04:13 -0500 Subject: [PATCH] Adding and adjusting repo issue templates (#1069) --- .../basic-issue-template.md} | 0 .../java-stable-release-template.md | 71 +++++++++++++++++++ circle.yml | 7 +- gradle/gradle-bintray.gradle | 2 +- 4 files changed, 77 insertions(+), 3 deletions(-) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/basic-issue-template.md} (100%) create mode 100644 .github/ISSUE_TEMPLATE/java-stable-release-template.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/basic-issue-template.md similarity index 100% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/basic-issue-template.md diff --git a/.github/ISSUE_TEMPLATE/java-stable-release-template.md b/.github/ISSUE_TEMPLATE/java-stable-release-template.md new file mode 100644 index 000000000..9d941b962 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/java-stable-release-template.md @@ -0,0 +1,71 @@ +### RELEASE_VERSION_NUMBER-alpha.1 pre-release checklist + +- [ ] Create a new branch off of `master`. +- [ ] Update the SNAPSHOT version in this repo's `README.md` file +- [ ] Update this repo's `CHANGELOG.md` +- [ ] Change version name to `RELEASE_VERSION_NUMBER-alpha.1` in this repo's `gradle.properties` (make sure to remove `-SNAPSHOT`) +- [ ] [Create a new Github release](https://github.com/mapbox/mapbox-java/releases/new) with a release title of `Mapbox Java SDK vRELEASE_VERSION_NUMBER-alpha.1`, a tag version of `vRELEASE_VERSION_NUMBER-alpha.1`, targeting the release branch you made above in step #1, and checking the `This is a pre-release` box. This will publish artifacts to Bintray. + +
+What to do in Bintray +After the tag is created, the CI build starts automatically at https://circleci.com/gh/mapbox/mapbox-java and our CircleCI circle.yml file instructs CircleCI to push the artifact to Bintray. + +Once CircleCI successfully pushes the artifact files to Bintray, log into Bintray with the Mapbox credentials. Once you're signed in, visit this release numbers's `Files` page for each of the Java SDK modules: + +- https://bintray.com/mapbox/mapbox/mapbox-sdk-turf#files/com/mapbox/mapboxsdk/mapbox-sdk-turf + +- https://bintray.com/mapbox/mapbox/mapbox-sdk-geojson#files/com/mapbox/mapboxsdk/mapbox-sdk-geojson + +- https://bintray.com/mapbox/mapbox/mapbox-sdk-services#files/com/mapbox/mapboxsdk/mapbox-sdk-services + +- https://bintray.com/mapbox/mapbox/mapbox-sdk-core#files/com/mapbox/mapboxsdk/mapbox-sdk-core + +Verify the attached files for each module, especially the POM which contains the artifact's dependencies. Go to the `Maven Central` tab and click the `Sync` button to sync the artifact with the repository. +
+ +- [ ] Change version name back to having `-SNAPSHOT` at the end + + +### RELEASE_VERSION_NUMBER-alpha.1 pre-release testing +- [ ] Create a pull request in [`/mapbox-gl-native`](https://github.com/mapbox/mapbox-gl-native) that updates the Mapbox Maps SDK for Android's Java SDK dependency to `RELEASE_VERSION_NUMBER-alpha.1` +- [ ] Create a pull request in [the Mapbox Navigation SDK for Android repo](https://github.com/mapbox/mapbox-navigation-android) that updates the Nav SDK's Java SDK dependency to `RELEASE_VERSION_NUMBER-alpha.1` +- [ ] Report any regressions on this ticket + +### Final RELEASE_VERSION_NUMBER release checklist +- [ ] Create a new branch off of `master`. +- [ ] Update this repo's `README.md` file +- [ ] Update `CHANGELOG.md` +- [ ] Change version name to `RELEASE_VERSION_NUMBER` in `gradle.properties` (removing `-SNAPSHOT`) +- [ ] [Create a new Github release](https://github.com/mapbox/mapbox-java/releases/new) with a release title of `Mapbox Java SDK vRELEASE_VERSION_NUMBER`, a tag version of `vRELEASE_VERSION_NUMBER`, targeting the final release branch you made above in step #1, and _not_ checking the `This is a pre-release` box. This will publish artifacts to Bintray. + +
+What to do in Bintray +After the tag is created, the CI build starts automatically at https://circleci.com/gh/mapbox/mapbox-java and our CircleCI circle.yml file instructs CircleCI to push the artifact to Bintray. + +Once CircleCI successfully pushes the artifact files to Bintray, log into Bintray with the Mapbox credentials. Once you're signed in, visit this release numbers's `Files` page for each of the Java SDK modules: + +- https://bintray.com/mapbox/mapbox/mapbox-sdk-turf#files/com/mapbox/mapboxsdk/mapbox-sdk-turf + +- https://bintray.com/mapbox/mapbox/mapbox-sdk-geojson#files/com/mapbox/mapboxsdk/mapbox-sdk-geojson + +- https://bintray.com/mapbox/mapbox/mapbox-sdk-services#files/com/mapbox/mapboxsdk/mapbox-sdk-services + +- https://bintray.com/mapbox/mapbox/mapbox-sdk-core#files/com/mapbox/mapboxsdk/mapbox-sdk-core + +Verify the attached files for each module, especially the POM which contains the artifact's dependencies. Go to the `Maven Central` tab and click the `Sync` button to sync the artifact with the repository. +
+ +- [ ] Change version name back to having `-SNAPSHOT` at the end + +### Post final release checklist +- [ ] Update dependencies in the Maps SDK and Navigation SDK to the final release version +- [ ] Update [the dependencies file in the Mapbox Android Plugins `/mapbox-plugins-android` repo](https://github.com/mapbox/mapbox-plugins-android/blob/master/gradle/dependencies.gradle#L11) +- [ ] Update version # in config files in the `/help` repo +- [ ] Update [the Mapox Android demo app](https://github.com/mapbox/mapbox-android-demo/blob/master/gradle/dependencies.gradle) +- [ ] After updating the demo app, make the following changes in the `/android-docs` repo: + - [ ] Update API reference Javadocs for the Mapbox Java docs section in `/android-docs` repo: + - [ ] Update [the `JAVA_SDK_VERSION` constant in the `constants.js` file in the `/android-docs` repo](https://github.com/mapbox/android-docs/blob/publisher-production/src/constants.json) +- [ ] Update version # in the Studio Preview for Android app +- [ ] Update version # in the China plugin test app + +/cc: @mapbox/android \ No newline at end of file diff --git a/circle.yml b/circle.yml index ee9800ece..3b7620363 100644 --- a/circle.yml +++ b/circle.yml @@ -4,7 +4,10 @@ workflows: default: jobs: - build - - release + - release: + filters: + tags: + only: /v.*/ jobs: build: working_directory: ~/code @@ -67,7 +70,7 @@ jobs: name: Update version name command: | if [[ $CIRCLE_TAG == v* ]]; then - sed -i -e "s/^VERSION_NAME=.*/VERSION_NAME=${CIRCLE_TAG:9}/" gradle.properties + sed -i -e "s/^VERSION_NAME=.*/VERSION_NAME=${CIRCLE_TAG:1}/" gradle.properties fi - run: name: Build Java libraries diff --git a/gradle/gradle-bintray.gradle b/gradle/gradle-bintray.gradle index e73cae382..e32f37dc2 100644 --- a/gradle/gradle-bintray.gradle +++ b/gradle/gradle-bintray.gradle @@ -52,7 +52,7 @@ publishing { bintray { user = mapboxBintrayUser key = mapboxBintrayApiKey - publications = ['MapboxJavaSDKPublication'] + publications('MapboxJavaSDKPublication') pkg { repo = project.ext.mapboxBintrayRepoName name = project.ext.mapboxArtifactId