CI now builds docs website and deploys it to /%version% path #5873
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/0.20 URL. All relative URLs will work within that website 3. If code is pushed to any `XX-stable` or `master` branch and this commit has a tag `latest` then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/ folder. Github will serve this website from https://facebook.github.io/react-native/ URL. All relative URLs will work within that website I have tested this in a fork, this is the example: http://bestander.github.io/react-native/ http://bestander.github.io/react-native/releases/next http://bestander.github.io/react-native/releases/0.40 http://bestander.github.io/react-native/releases/0.41 Caveats: Searchdocs algolia works only with stable version of website, so it will redirect from a versioned to the stable one. Next steps: - widget/page to switch between versions of websites (still to decide) - (?) simple UI indication mechanism that you are observing not latest/stable docs
Contributor
Author
|
@facebook-github-bot shipit |
Contributor
Author
|
@facebook-github-bot import |
Contributor
|
dances around a fire mumbles unspeakable words stirs a large pot of magical potions @facebook-github-bot shipit |
Contributor
Author
|
I think the bot not only ignores my shipit commands but also she ignores PRs coming from me |
Contributor
Author
|
@facebook-github-bot shipit :( :( :( |
Contributor
|
@facebook-github-bot shipit |
Contributor
|
sheeeeeep eeeeeeet |
Contributor
Author
|
@facebook-github-bot shipit |
1 similar comment
Contributor
Author
|
@facebook-github-bot shipit |
facebook-github-bot
added
GH Review: accepted
and removed
GH Review: review-needed
labels
Contributor
|
Thanks for importing. If you are an FB employee go to https://our.intern.facebook.com/intern/opensource/github/pull_request/1675489296056438/int_phab to review. |
Contributor
|
@bestander updated the pull request. |
Contributor
|
What a lovely bot. lol |
ghost
closed this
in
bestander
added a commit
that referenced
this pull request
Feb 12, 2016
Summary: Copy of #5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes #5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1 Conflicts: circle.yml
bestander
added a commit
that referenced
this pull request
Feb 12, 2016
Summary: Copy of #5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes #5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1 Conflicts: Libraries/Utilities/AlertIOS.js circle.yml website/layout/AutodocsLayout.js
bestander
added a commit
that referenced
this pull request
Feb 15, 2016
Summary: Copy of #5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes #5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1 Conflicts: Libraries/Utilities/AlertIOS.js circle.yml website/layout/AutodocsLayout.js Conflicts: Libraries/Components/ScrollView/ScrollView.js Libraries/PushNotificationIOS/PushNotificationIOS.js docs/GettingStarted.md website/publish.sh
pglotov
pushed a commit
to pglotov/react-native
that referenced
this pull request
Mar 15, 2016
Summary: Copy of facebook#5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes facebook#5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Copy of #5760 reverted merge.
We need to preserve history of docs changes on the webserver.
The goal is to allow users to browse outdated versions of docs.
To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut.
I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it.
How it works:
masterbranch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder.Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL.
All relative URLs will work within that website
0.20-stablebranch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder.Github will serve this website from https://facebook.github.io/react-native/releases/version/0.20 URL.
All relative URLs will work within that website
XX-stableormasterbranch and this commit has a taglatestthen CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/ folder.Github will serve this website from https://facebook.github.io/react-native/ URL.
All relative URLs will work within that website
I have tested this in a fork, this is the example:
http://bestander.github.io/react-native/
http://bestander.github.io/react-native/releases/next
http://bestander.github.io/react-native/releases/0.40
http://bestander.github.io/react-native/releases/0.41
Caveats: Searchdocs algolia works only with stable version of website, so it will redirect from a versioned to the stable one.
Next steps: