OpenAPI-Specification icon indicating copy to clipboard operation
OpenAPI-Specification copied to clipboard

Move gh-pages into main branch

Open Bellangelo opened this issue 1 year ago • 6 comments

Closes https://github.com/OAI/OpenAPI-Specification/issues/3717

What I have done:

  1. Go to gh-pages and move all files under the docs folder which Github supports.
  2. Go to main branch and run git merge gh-pages --allow-unrelated-histories. This merged the 2 branches even if they had unrelated histories.
  3. Updated scripts and references. There are some references in the spec.js files but I think they are unused.

What we need to do after merge:

  1. Go to Settings>Pages and under the Branch section select the main branch and the docs folder`. image
  2. After you update the settings, an action will run to deploy the site again.
  3. We keep the 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 just git diff to distinguished what files have been moved and what files contain actual changes.

Bellangelo avatar May 31 '24 00:05 Bellangelo

Aside from the one comment, this looks good to me. I'm just going to hold off actually approving it until we know who has the permissions to do the actual deployment changes and can be sure that they'll merge and make those changes at the same time. [EDIT: Plus we're still considering just making a separate repo]

handrews avatar Jun 03 '24 17:06 handrews

I don't have the permissions needed. I see the source, but not the branch picker.

How can we test this before we do it? Did you try it out on o a public fork, or who can do that? I expected the scripts/ directory (currently only exists in main) to need some changes to get the outputs to build in the target folder (we must currently have some "release" step for this, I'm not sure how that works) - did we check that?

lornajane avatar Jun 03 '24 18:06 lornajane

I don't have the permissions needed. I see the source, but not the branch picker.

How can we test this before we do it? Did you try it out on o a public fork, or who can do that? I expected the scripts/ directory (currently only exists in main) to need some changes to get the outputs to build in the target folder (we must currently have some "release" step for this, I'm not sure how that works) - did we check that?

@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.

Bellangelo avatar Jun 04 '24 22:06 Bellangelo

I've created issue https://github.com/OAI/Arazzo-Specification/issues/207 on the Arazzo repo to change our respec job so that it will work with the new structure.

frankkilcommins avatar Jun 12 '24 08:06 frankkilcommins

Also note that https://github.com/OAI/OpenAPI-Specification/pull/3900 will need to be incorporated into this PR if it's merged prior to this PR.

frankkilcommins avatar Jun 12 '24 08:06 frankkilcommins

@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.

lornajane avatar Jun 30 '24 20:06 lornajane

Sorry, closed the wrong PR!

lornajane avatar Oct 31 '24 17:10 lornajane

TDC decision: @ralfhandl to copy relevant instructions to #3717 and then close this PR.

ralfhandl avatar Nov 28 '24 17:11 ralfhandl

TDC decision: @ralfhandl to copy relevant instructions to #3717 and then close this PR.

Montiwa11 avatar Dec 01 '24 22:12 Montiwa11

I got impatient and copied the info over so we could reach zero open PRs 😁

handrews avatar Dec 02 '24 22:12 handrews