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.

Sign up for GitHub

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

Jump to bottom

Rename MapboxDirections.swift to Mapbox Directions for Swift #399

Closed
8 tasks done
1ec5 opened this issue Dec 27, 2019 · 2 comments
Closed
8 tasks done

Rename MapboxDirections.swift to Mapbox Directions for Swift #399

1ec5 opened this issue Dec 27, 2019 · 2 comments
Assignees
@1ec5
Labels
backwards incompatible changes that break backwards compatibility of public API build op-ex Refactoring, Tech Debt or any other operational excellence work.
Milestone
v0.31.0

Comments

@1ec5
Copy link
Contributor

1ec5 commented Dec 27, 2019 •
edited
Loading

This project was originally named MapboxDirections.swift because it started as a single file named MapboxDirections.swift in 6f73004. (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: #318 (comment). Having “.swift” in the name also caused confusion back when the library also supported Objective-C. We’ve just dropped Objective-C support, but emphasizing Swift in contrast to Objective-C matters less and less these days in Apple-centric environments like CocoaPods.

For v1.0, we’re planning to rename the project to “Mapbox Directions for Swift”, the repository to mapbox/mapbox-directions-swift, and the pod to simply “MapboxDirections”. Any developer installing the library using CocoaPods would need to replace MapboxDirections.swift with MapboxDirections in their Podfile. Otherwise, there’s no immediate impact to developers, since GitHub automatically redirects renamed repositories.

The steps to rename look roughly like this:

  • Replace occurrences of “MapboxDirections.swift” in the repository: Rename MapboxDirections.swift to Mapbox Directions for Swift #400
  • Rename the repository to mapbox/mapbox-directions-swift
  • Update Bitrise configuration
  • Update CircleCI configuration
  • Update Codecov configuration
  • Publish v1.0 (and any prereleases) to a new “MapboxDirections” pod: v1.0.0-alpha.1 #398
  • Deprecate the MapboxDirections.swift pod in favor of the MapboxDirections pod
  • Update documentation across docs.mapbox.com

CocoaPods doesn’t have a built-in way to rename a pod, so we’ll have to create a new pod and deprecate the old one. We could continue to publish the pod under both names for a while, but I’m not sure that maintenance overhead is really necessary given the disruption that v1.0 will cause regardless.

When we created the Mapbox Speech for Swift project, we avoid the “.swift” nomenclature in anticipation of a similar rename across all the other Swift service libraries, including MapboxGeocoder.swift and MapboxStatic.swift. That’ll be tracked in separate issues in the respective repositories.

(This rename was originally attempted in #366 and #362.)

/cc @mapbox/navigation-ios @mapbox/docs @mapbox/ios @mapbox/driver-app
@1ec5 1ec5 added build backwards incompatible changes that break backwards compatibility of public API op-ex Refactoring, Tech Debt or any other operational excellence work. labels Dec 27, 2019
@1ec5 1ec5 added this to the v1.0 milestone Dec 27, 2019
@1ec5 1ec5 mentioned this issue Dec 27, 2019
Merged
@1ec5 1ec5 self-assigned this Jan 11, 2020
@1ec5 1ec5 mentioned this issue Mar 17, 2020
Open
8 tasks
@1ec5 1ec5 modified the milestones: v1.0.0, v0.31.0 (v0.40) Apr 14, 2020
@1ec5
Copy link
Contributor Author

1ec5 commented May 29, 2020

Deprecate the MapboxDirections.swift pod in favor of the MapboxDirections pod

The command didn’t go as I had expected, but MapboxDirections.swift does appear to be deprecated in favor of MapboxDirections:

$ pod trunk deprecate 'MapboxDirections.swift' --in-favor-of=MapboxDirections
[!] An unexpected error occurred: <!DOCTYPE html>
	<html>
	  <head>
		<meta name="viewport" content="width=device-width, initial-scale=1">
		<meta charset="utf-8">
		<title>Application Error</title>
		<style media="screen">
		  html,body,iframe {
			margin: 0;
			padding: 0;
		  }
		  html,body {
			height: 100%;
			overflow: hidden;
		  }
		  iframe {
			width: 100%;
			height: 100%;
			border: 0;
		  }
		</style>
	  </head>
	  <body>
		<iframe src="//www.herokucdn.com/error-pages/application-error.html"></iframe>
	  </body>
	</html>

@1ec5 1ec5 closed this as completed May 29, 2020
@1ec5
Copy link
Contributor Author

1ec5 commented May 29, 2020 •
edited
Loading

Fixed by CocoaPods/Specs@5cb64f2...1baaee8.

@1ec5 1ec5 mentioned this issue Nov 7, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@1ec5 1ec5

Labels
backwards incompatible changes that break backwards compatibility of public API build op-ex Refactoring, Tech Debt or any other operational excellence work.
Projects
None yet
Milestone
v0.31.0
Development

No branches or pull requests
1 participant
@1ec5