Skip to content

Commit 9bd6158

Browse files
author
Langston Smith
authored
Adding and adjusting repo issue templates (#1069)
1 parent 4229ef0 commit 9bd6158

File tree

4 files changed

+77
-3
lines changed

4 files changed

+77
-3
lines changed

.github/ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/basic-issue-template.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/java-stable-release-template.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
### RELEASE_VERSION_NUMBER-alpha.1 pre-release checklist
2+
3+
- [ ] Create a new branch off of `master`.
4+
- [ ] Update the SNAPSHOT version in this repo's `README.md` file
5+
- [ ] Update this repo's `CHANGELOG.md`
6+
- [ ] Change version name to `RELEASE_VERSION_NUMBER-alpha.1` in this repo's `gradle.properties` (make sure to remove `-SNAPSHOT`)
7+
- [ ] [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.
8+
9+
<details>
10+
<summary>What to do in Bintray</summary>
11+
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.
12+
13+
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:
14+
15+
- https://bintray.com/mapbox/mapbox/mapbox-sdk-turf#files/com/mapbox/mapboxsdk/mapbox-sdk-turf
16+
17+
- https://bintray.com/mapbox/mapbox/mapbox-sdk-geojson#files/com/mapbox/mapboxsdk/mapbox-sdk-geojson
18+
19+
- https://bintray.com/mapbox/mapbox/mapbox-sdk-services#files/com/mapbox/mapboxsdk/mapbox-sdk-services
20+
21+
- https://bintray.com/mapbox/mapbox/mapbox-sdk-core#files/com/mapbox/mapboxsdk/mapbox-sdk-core
22+
23+
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.
24+
</details>
25+
26+
- [ ] Change version name back to having `-SNAPSHOT` at the end
27+
28+
29+
### RELEASE_VERSION_NUMBER-alpha.1 pre-release testing
30+
- [ ] 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`
31+
- [ ] 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`
32+
- [ ] Report any regressions on this ticket
33+
34+
### Final RELEASE_VERSION_NUMBER release checklist
35+
- [ ] Create a new branch off of `master`.
36+
- [ ] Update this repo's `README.md` file
37+
- [ ] Update `CHANGELOG.md`
38+
- [ ] Change version name to `RELEASE_VERSION_NUMBER` in `gradle.properties` (removing `-SNAPSHOT`)
39+
- [ ] [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.
40+
41+
<details>
42+
<summary>What to do in Bintray</summary>
43+
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.
44+
45+
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:
46+
47+
- https://bintray.com/mapbox/mapbox/mapbox-sdk-turf#files/com/mapbox/mapboxsdk/mapbox-sdk-turf
48+
49+
- https://bintray.com/mapbox/mapbox/mapbox-sdk-geojson#files/com/mapbox/mapboxsdk/mapbox-sdk-geojson
50+
51+
- https://bintray.com/mapbox/mapbox/mapbox-sdk-services#files/com/mapbox/mapboxsdk/mapbox-sdk-services
52+
53+
- https://bintray.com/mapbox/mapbox/mapbox-sdk-core#files/com/mapbox/mapboxsdk/mapbox-sdk-core
54+
55+
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.
56+
</details>
57+
58+
- [ ] Change version name back to having `-SNAPSHOT` at the end
59+
60+
### Post final release checklist
61+
- [ ] Update dependencies in the Maps SDK and Navigation SDK to the final release version
62+
- [ ] 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)
63+
- [ ] Update version # in config files in the `/help` repo
64+
- [ ] Update [the Mapox Android demo app](https://github.com/mapbox/mapbox-android-demo/blob/master/gradle/dependencies.gradle)
65+
- [ ] After updating the demo app, make the following changes in the `/android-docs` repo:
66+
- [ ] Update API reference Javadocs for the Mapbox Java docs section in `/android-docs` repo:
67+
- [ ] 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)
68+
- [ ] Update version # in the Studio Preview for Android app
69+
- [ ] Update version # in the China plugin test app
70+
71+
/cc: @mapbox/android

‎circle.yml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ workflows:
44
default:
55
jobs:
66
- build
7-
- release
7+
- release:
8+
filters:
9+
tags:
10+
only: /v.*/
811
jobs:
912
build:
1013
working_directory: ~/code
@@ -67,7 +70,7 @@ jobs:
6770
name: Update version name
6871
command: |
6972
if [[ $CIRCLE_TAG == v* ]]; then
70-
sed -i -e "s/^VERSION_NAME=.*/VERSION_NAME=${CIRCLE_TAG:9}/" gradle.properties
73+
sed -i -e "s/^VERSION_NAME=.*/VERSION_NAME=${CIRCLE_TAG:1}/" gradle.properties
7174
fi
7275
- run:
7376
name: Build Java libraries

‎gradle/gradle-bintray.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ publishing {
5252
bintray {
5353
user = mapboxBintrayUser
5454
key = mapboxBintrayApiKey
55-
publications = ['MapboxJavaSDKPublication']
55+
publications('MapboxJavaSDKPublication')
5656
pkg {
5757
repo = project.ext.mapboxBintrayRepoName
5858
name = project.ext.mapboxArtifactId

0 commit comments

Comments
 (0)