Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift #205

Open
8 tasks
1ec5 opened this issue Mar 17, 2020 · 0 comments
Open
8 tasks

Rename MapboxGeocoder.swift to Mapbox Geocoder for Swift #205

1ec5 opened this issue Mar 17, 2020 · 0 comments
Labels
backwards-incompatible changes that break backwards compatibility of public API build
Milestone

Comments

@1ec5
Copy link
Contributor

1ec5 commented Mar 17, 2020

This project was originally named MapboxGeocoder.swift because it started as a single file named MapboxGeocoder.swift in 2c2a827. (Lore has it that, even before this repository existed, it was a gist by the same name.) Over the years, the “dot swift” extension has been a bit of a mouthful and even occasionally a source of build issues: #59 (comment). Having “.swift” in the name also causes confusion because the library also supports Objective-C. Emphasizing Swift in contrast to Objective-C matters less and less these days in Apple-centric environments like CocoaPods.

As we’re doing with MapboxDirections.swift in mapbox/mapbox-directions-swift#399, I think we should consider renaming the project to “Mapbox Geocoder for Swift”, the repository to mapbox/mapbox-geocoder-swift, and the pod to simply “MapboxGeocoder”. Any developer installing the library using CocoaPods would need to replace MapboxGeocoder.swift with MapboxGeocoder in their Podfile. Otherwise, there’s no immediate impact to developers, since GitHub automatically redirects renamed repositories.

Ideally, this change would take place as part of a v1.0 release that also drops Objective-C compatibility. However, there aren’t active plans for either at the moment, so this issue is just a placeholder for now.

The steps to rename look roughly like this:

  • Replace occurrences of “MapboxGeocoder.swift” in the repository
  • Rename the repository to mapbox/mapbox-geocoder-swift
  • Update Bitrise configuration
  • Update CircleCI configuration
  • Update Codecov configuration
  • Publish v1.0 (and any prereleases) to a new “MapboxGeocoder” pod
  • Deprecate the MapboxGeocoder.swift pod in favor of the MapboxGeocoder pod
  • Update documentation across docs.mapbox.com

/cc @mapbox/ios

@1ec5 1ec5 added build backwards-incompatible changes that break backwards compatibility of public API labels Mar 17, 2020
@1ec5 1ec5 added this to the v1.0.0 milestone Mar 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backwards-incompatible changes that break backwards compatibility of public API build
Projects
None yet
Development

No branches or pull requests

1 participant