-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Move gh-pages into main branch #3868
Conversation
…OpenAPI-Specification.git:gh-pages
gh-pages; Draft registry content
Add v3.0.2 respec/html
gh-pages; update index.md
[gh-pages] Hand-craft API templates for leaner output
Signed-off-by: Mike Ralphson <[email protected]>
Make 3.1 schemas retrievable from their $ids
Signed-off-by: Mike Ralphson <[email protected]>
Add v3.1 2021-05-20 schemas to website
Signed-off-by: Mike Ralphson <[email protected]>
Signed-off-by: GitHub <[email protected]> Co-authored-by: webron <[email protected]>
* Added formats to the registry as defined by OpenAPI v3 * Fixed date-time format * Removed boolean as format is not needed
@lornajane My bad. My fork is the https://github.com/Bellangelo/OpenAPI-Specification which deploys to the https://bellangelo.github.io/OpenAPI-Specification/. I have made some extra changes to the deploy / build scripts based on some finding from @ralfhandl . If you check this action https://github.com/Bellangelo/OpenAPI-Specification/actions/runs/9375129267 you can see that it passes. The way I have been testing the changes in the site so far is mainly using the fork. The fork copies also some repo settings about the deployment but you have to fork through the Github's UI. If you do this, you will be able to deploy the same way we deploy here but in our own url. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tested on a fork, respec workflow and github pages work fine
I've created issue OAI/Arazzo-Specification#207 on the Arazzo repo to change our respec job so that it will work with the new structure. |
Also note that #3900 will need to be incorporated into this PR if it's merged prior to this PR. |
@Bellangelo just wanted to drop you a note to say we haven't forgotten about your excellent work, just a lot of moving parts. We will figure it out. |
Sorry, closed the wrong PR! |
TDC decision: @ralfhandl to copy relevant instructions to #3717 and then close this PR. |
This comment was marked as spam.
This comment was marked as spam.
I got impatient and copied the info over so we could reach zero open PRs 😁 |
Closes #3717
What I have done:
gh-pages
and move all files under thedocs
folder which Github supports.main
branch and rungit merge gh-pages --allow-unrelated-histories
. This merged the 2 branches even if they had unrelated histories.What we need to do after merge:
Settings
>Pages
and under theBranch
section select themain
branch and thedocs
folder`.gh-pages
for a few weeks, just to be able to quickly change in case of a bug in the process, and then we delete it.How to review
To quickly skip and verify the updated files, just follow the
What I have done
section and then you can justgit diff
to distinguished what files have been moved and what files contain actual changes.