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

MIgrate nav docs script over ios-sdk repo #2668

Closed
wants to merge 3 commits into from
Closed

Conversation

danswick
Copy link
Contributor

@danswick danswick commented Sep 30, 2020

Related: mapbox/mapbox-directions-swift#467

This PR will move the shell script for generating documentation from /ios-sdk into this repo. The script will generate the documentation, switch and commit the new version on the publisher-production branch.

To do:

  • Verify version branch naming convention
  • Test script
  • Document!

cc @katydecorah and @1ec5

Ref mapbox/ios-sdk#980

Copy link
Contributor

@1ec5 1ec5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, I think we should also name the script something more descriptive, like publish-documentation.sh.

scripts/update-navigation.sh Outdated Show resolved Hide resolved
scripts/update-navigation.sh Outdated Show resolved Hide resolved
scripts/update-navigation.sh Outdated Show resolved Hide resolved
@1ec5
Copy link
Contributor

1ec5 commented Oct 1, 2020

The CircleCI build failures are due to Homebrew unreliability that #2667 will work around by downloading Carthage directly from GitHub.

@1ec5 1ec5 changed the base branch from master to main October 7, 2020 18:20
@1ec5 1ec5 added build Issues related to builds and dependency management. documentation topic: documentation labels Oct 16, 2020
@1ec5 1ec5 added this to the v1.1.0 milestone Oct 16, 2020

step "Moving new docs folder to ./$VERSION"
rm -rf "./$VERSION"
mkdir -p "./navigation/api/$VERSION"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it correct path? As I can see later in this script we attempt to add contents from ./$VERSION, here on the other hand we create ./navigation/api/$VERSION folder.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing that out, @MaximAlien. You are correct and I've updated this value.

@1ec5 1ec5 modified the milestones: v1.1.0, v1.2.0 Oct 27, 2020
@danswick danswick marked this pull request as ready for review October 31, 2020 03:54
@danswick
Copy link
Contributor Author

Thank you @1ec5 and @MaximAlien for your comments. I've made some updates to address the issues you've pointed out. I tested locally and all seemed to work. I would appreciate another tester if anyone has some spare cycles.

@danswick danswick changed the title Begin moving nav docs script over from ios-sdk MIgrate nav docs script over ios-sdk repo Oct 31, 2020
@truburt truburt removed this from the e (android-v1.5.0 / ios-v1.3.0) milestone Feb 26, 2021
@stale
Copy link

stale bot commented Jun 9, 2021

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the archived Archived issue. label Jun 9, 2021
@stale
Copy link

stale bot commented Jul 21, 2021

Stale.

@stale stale bot closed this Jul 21, 2021
@1ec5 1ec5 mentioned this pull request Oct 5, 2021
@1ec5 1ec5 deleted the migrate-docs-script branch October 5, 2021 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
archived Archived issue. build Issues related to builds and dependency management. documentation topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants