Skip to content

Commit d6c41e3

Browse files
committed
Moved release documentation to contributing guide
Removed testing documentation, now redundant to instructions in the contributing guide.
1 parent 97cd292 commit d6c41e3

File tree

2 files changed

+16
-23
lines changed

2 files changed

+16
-23
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,18 @@ Go to Product ‣ Test in Xcode, or run `swift test` on the command line.
7575
Pull requests are appreciated. If your PR includes any changes that would impact developers or end users, please mention those changes in the “main” section of [CHANGELOG.md](CHANGELOG.md), noting the PR number. Examples of noteworthy changes include new features, fixes for user-visible bugs, and renamed or deleted public symbols.
7676

7777
Before we can merge your PR, it must pass automated continuous integration checks on each of the supported platforms, as well as a check to ensure that code coverage has not decreased significantly.
78+
79+
## Releasing a new version
80+
81+
To release a new version of the MapboxDirections package:
82+
83+
1. Run `./scripts/update-version.sh v#.#.#`, where _#.#.#_ is a new version number conforming to [Semantic Versioning](https://semver.org/). Commit the changes with a commit message like `v#.#.#` and open a pull request to get it reviewed and merged.
84+
1. Tag the merged changes as `v#.#.#`. Push the tag by running `git pull && git push origin v#.#.#`.
85+
1. [Create a new release](https://github.com/mapbox/mapbox-directions-swift/releases/new/). Add release notes based on the release’s section in the changelog. (Unlike the changelog, release notes accept `#123` syntax for linking to PRs.) Title the release `v#.#.#`. Check “This is a pre-release” if applicable, then click “Publish release”.
86+
1. Run `pod repo update && pod trunk push` to publish the release on CocoaPods trunk.
87+
88+
After the release, follow these steps to generate and publish documentation and update the iOS site with the latest version number:
89+
90+
1. Run `./scripts/publish-documentation.sh v#.#.#` to generate and publish the documentation. Create a pull request and set the base branch to `publisher-production`.
91+
2. Wait for new documentation to be live. Once you merge the branch into `publisher-production`, the new version will be available within 10 minutes. (Mapbox employees can check the #publisher channel in Slack for a notification of when the commit has been published.)
92+
3. _(Mapbox employees only.)_ Complete the [MapboxDirections.swift instructions](https://github.com/mapbox/ios-sdk#mapboxdirectionsswift) in the ios-sdk repository to update various links to the current docset.

README.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -194,26 +194,4 @@ if var routeCoordinates = route.shape?.coordinates, routeCoordinates.count > 0 {
194194

195195
### Displaying a turn-by-turn navigation interface
196196

197-
See the [Mapbox Navigation SDK for iOS](https://github.com/mapbox/mapbox-navigation-ios/#usage) documentation for usage examples.
198-
199-
## Tests
200-
201-
To run the included unit tests, you need to use [Carthage](https://github.com/Carthage/Carthage) 0.19 or above to install the dependencies.
202-
203-
1. `carthage build --platform iOS`
204-
1. `open MapboxDirections.xcodeproj`
205-
1. Go to Product ‣ Test.
206-
207-
## Publish documentation
208-
209-
After a release, follow these steps to generate and publish documentation and update the iOS site with the latest version number:
210-
211-
1. Generate and publish the documentation.
212-
- Run `./scripts/publish-documentation.sh v#.#.#` replacing `v#.#.#` with the release version number.
213-
- This script will checkout the release branch, install dependencies, generate the documentation, and commit the generated documentation to a new branch.
214-
- Create a pull request and set the base branch to `publisher-production`.
215-
2. Wait for new documentation to be live.
216-
- Once you merge the branch into `publisher-production`, the new version will be available within 10 minutes.
217-
- You can check the #publisher channel in Slack for a notification of when your commit has been published.
218-
3. Update the ios-sdk repository constants.
219-
- Complete the [MapboxDirections.swift instructions](https://github.com/mapbox/ios-sdk#mapboxdirectionsswift) in the ios-sdk repository.
197+
The [Mapbox Navigation SDK for iOS](https://github.com/mapbox/mapbox-navigation-ios/) provides a full-fledged user interface for turn-by-turn navigation along routes supplied by MapboxDirections.

0 commit comments

Comments
 (0)