Move gh-pages into main branch by Bellangelo · Pull Request #3868 · OAI/OpenAPI-Specification

Bellangelo · 2024-05-31T00:23:41Z

What I have done:

Go to gh-pages and move all files under the docs folder which Github supports.
Go to main branch and run git merge gh-pages --allow-unrelated-histories. This merged the 2 branches even if they had unrelated histories.
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:

Go to Settings>Pages and under the Branch section select the main branch and the docs folder`.
After you update the settings, an action will run to deploy the site again.
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.

…OpenAPI-Specification.git:gh-pages

gh-pages; Draft registry content

…ecification into gh-pages

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 <mike.ralphson@gmail.com>

Make 3.1 schemas retrievable from their $ids

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>

Add v3.1 2021-05-20 schemas to website

Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>

Signed-off-by: GitHub <noreply@github.com> Co-authored-by: webron <webron@users.noreply.github.com>

* Added formats to the registry as defined by OpenAPI v3 * Fixed date-time format * Removed boolean as format is not needed

lornajane · 2024-06-03T18:47:10Z

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?

Bellangelo · 2024-06-04T22:41:45Z

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.

ralfhandl

Tested on a fork, respec workflow and github pages work fine

frankkilcommins · 2024-06-12T08:53:31Z

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.

frankkilcommins · 2024-06-12T08:55:26Z

Also note that #3900 will need to be incorporated into this PR if it's merged prior to this PR.

lornajane · 2024-06-30T20:42:22Z

@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 · 2024-10-31T17:05:45Z

Sorry, closed the wrong PR!

ralfhandl · 2024-11-28T17:12:44Z

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

handrews · 2024-12-02T22:28:17Z

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

MikeRalphsonand others added 30 commits June 14, 2018 10:57

Initial commit
5051498

Add index.md, v2.0 and v3.0.0
52affa2

Create CNAME
68215a3

Deploy MikeRalphson/OpenAPI-Specification to github.com/MikeRalphson/…
74ee685
…OpenAPI-Specification.git:gh-pages

draft registry content
1d5c5cb

Merge pull requestOAI#1762from MikeRalphson/registry
4d03d09
gh-pages; Draft registry content

Update index.md with clearer title and desc.
e7f201c

Merge branch 'gh-pages' ofhttps://github.com/mikeralphson/openapi-sp…
fa84486
…ecification into gh-pages

Add v3.0.2 respec/html
81409a6

Merge pull requestOAI#1796from MikeRalphson/add3.0.2
ba51031
Add v3.0.2 respec/html

Merge pull requestOAI#1774from MikeRalphson/gh-pages
9cd199d
gh-pages; update index.md

Hand-craft API templates for leaner output
523ad57

Merge pull requestOAI#1808from MikeRalphson/gh-pages
5a4d660
[gh-pages] Hand-craft API templates for leaner output

gh-pages: add v3.0.3.html (OAI#2151)
b24e2fd

gh-pages: don't mix https and http content (toc) (OAI#2154)
f0a6bef

gh-pages: add v3.1.0.html (OAI#2464)
62d0c05
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>

Make 3.1 schemas retrievable from their $ids
dd98272

Merge pull requestOAI#2509from jdesrosiers/gh-pages
2f56ee7
Make 3.1 schemas retrievable from their $ids

fix: regenerate respec versions, refsOAI#2488(OAI#2573)
b92609b
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>

iAdd v3.1 2021-05-20 schemas to website
bf82a1d

Merge pull requestOAI#2587from jdesrosiers/deploy-2021-05-20-schema
8193ef8
Add v3.1 2021-05-20 schemas to website

Add v3.1 2021-04-15 schemas to website (OAI#2545)
5948c36

gh-pages: change text of Abstract heading (OAI#2606)
c0e7db7
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>

Update ReSpec versions (OAI#2615)
086a633
Signed-off-by: GitHub <noreply@github.com> Co-authored-by: webron <webron@users.noreply.github.com>

Release 2021-09-28 schemas for v3.0 and v3.1 (OAI#2732)
bf1b16b

Fix typo in URL for 3.0 schema release (OAI#2741)
88b7cb0

Add "latest" URLs for downloading meta schemas (OAI#2747)
18717ad

Fix "latest" symlink for 3.0 schema (OAI#2810)
54da8c5

Added formats to the registry as defined by OpenAPI v3 (OAI#2857)
68ed2e4
* Added formats to the registry as defined by OpenAPI v3 * Fixed date-time format * Removed boolean as format is not needed

Add version 2022-02-27 of v3.1 schemas (OAI#2889)
2ac4417

ralfhandl requested changes Jun 4, 2024
View reviewed changes

Comment thread.github/workflows/respec.yaml Outdated
Comment thread.github/workflows/respec.yaml Outdated
Comment threaddocs/LICENSE Outdated
Comment thread.github/workflows/respec.yaml

handrews requested a review from a teamJune 4, 2024 18:59

Bellangelo added 5 commits June 5, 2024 00:33

LICENSE exists in the root directory
0eba3e5

Remove unnecessary ignores
83770b9

Set the TSC group as PR reviewers
38e249c

Build site without the deploy folder
e7a5999

No need to specify a path
fbee8d4

Bellangelo requested review from handrews and ralfhandl June 4, 2024 22:42

ralfhandl requested changes Jun 5, 2024
View reviewed changes

Comment threadscripts/md2html/build.sh Outdated

Remove files from old implementation
9d361f6

Bellangelo requested a review from ralfhandl June 5, 2024 22:32

ralfhandl approved these changes Jun 6, 2024
View reviewed changes

handrews mentioned this pull request Jun 6, 2024
Open Community (TDC) Meeting, Thursday 13 June 2024 #3888
Closed

lornajane mentioned this pull request Jun 13, 2024
Should we-organize our GitHub pages to a separate repo (by way of a directory on main)? #3717
Closed

mikekistler mentioned this pull request Aug 20, 2024
Open Community (TDC) Meeting, Thursday 22 August 2024 #4028
Closed

ralfhandl marked this pull request as draft August 23, 2024 11:41

handrews mentioned this pull request Oct 25, 2024
Describe new spec branch and file layout #4154
Merged

lornajane closed this Oct 31, 2024

lornajane reopened this Oct 31, 2024

This comment was marked as spam.
Sign in to view

handrews closed this Dec 2, 2024

Navigation Menu

Uh oh!

Move gh-pages into main branch - #3868

Move gh-pages into main branch#3868
Bellangelo wants to merge 188 commits into
OAI:mainfrom
Bellangelo:main

Bellangelo commented May 31, 2024•
edited
Loading

Uh oh!

lornajane commented Jun 3, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Bellangelo commented Jun 4, 2024

Uh oh!

Uh oh!

ralfhandl left a comment

Uh oh!

frankkilcommins commented Jun 12, 2024

Uh oh!

frankkilcommins commented Jun 12, 2024

Uh oh!

lornajane commented Jun 30, 2024

Uh oh!

lornajane commented Oct 31, 2024

Uh oh!

ralfhandl commented Nov 28, 2024

Uh oh!

This comment was marked as spam.

handrews commented Dec 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

18 participants

Uh oh!

Conversation

Bellangelo commented May 31, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lornajane commented Jun 3, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Bellangelo commented Jun 4, 2024

Uh oh!

Uh oh!

ralfhandl left a comment

Choose a reason for hiding this comment

Uh oh!

frankkilcommins commented Jun 12, 2024

Uh oh!

frankkilcommins commented Jun 12, 2024

Uh oh!

lornajane commented Jun 30, 2024

Uh oh!

lornajane commented Oct 31, 2024

Uh oh!

ralfhandl commented Nov 28, 2024

Uh oh!

This comment was marked as spam.

handrews commented Dec 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

18 participants

Bellangelo commented May 31, 2024•
edited
Loading