Basic example of hosting API specs

Timeboxed to about 1.5h of work, makes a very basic nginx container hosting multiple openapi specs on the web. Will need additional work to add a landing page

Current generation structure for this script. Note that static is the only folder sent to the docker daemon so builds should be supremely quick and light. I've excluded node_modules from this since its very bloaty and not important.

❯ tree -I node_modules
.
├── docker-compose.yaml
├── Dockerfile
├── fetch.sh
├── Makefile
├── package.json
├── repos.properties
├── static
│   ├── eclipsefdn-downloads-api
│   │   └── index.html
│   └── eclipsefdn-mailing-lists-api
│       └── index.html
├── tmp
│   ├── eclipsefdn-downloads-api
│   │   ├── CODE_OF_CONDUCT.md
│   │   ├── CONTRIBUTING.md
│   │   ├── docker-compose.yml
│   │   ├── Jenkinsfile
│   │   ├── LICENSE
│   │   ├── Makefile
│   │   ├── mvnw
│   │   ├── mvnw.cmd
│   │   ├── NOTICE.md
│   │   ├── package.json
│   │   ├── pom.xml
│   │   ├── README.md
│   │   ├── spec
│   │   │   └── openapi.yaml
│   │   └── yarn.lock
│   └── eclipsefdn-mailing-lists-api
│       ├── CODE_OF_CONDUCT.md
│       ├── CONTRIBUTING.md
│       ├── docker-compose.yml
│       ├── Jenkinsfile
│       ├── LICENSE
│       ├── Makefile
│       ├── mvnw
│       ├── mvnw.cmd
│       ├── NOTICE.md
│       ├── package.json
│       ├── pom.xml
│       ├── README.md
│       ├── spec
│       │   └── openapi.yaml
│       └── yarn.lock
└── yarn.lock

Also note, I'm using git to fetch the repos so we don't have any strange traffic over web that could be subject to rate limit. This is about as light as I could get it, as it will always pull the root files

added 1 commit

• bcd917e5 - Added Jenkinsfile for preview, added super basic hugo site

Compare with previous version

added 3 commits

• db56d9cd - 1 commit from branch main
• a237894a - Basic example of hosting
• c2c2f698 - Added Jenkinsfile for preview, added super basic hugo site

Compare with previous version

Deploy Preview for webdev.eclipse.org-spec-host has failed [ 29 sec]

Inspect the build logs

Restart a deploy now

added 1 commit

• bca8e8c0 - Fix build script in Jenkinsfile

Compare with previous version

Deploy Preview for webdev.eclipse.org-spec-host has failed [ 1 min 48 sec]

Inspect the build logs

Restart a deploy now

added 2 commits

• 97e37e74 - Fix build script in Jenkinsfile
• 5b6b7ee4 - Switch to use curl instead of git to fetch openapi specs

Compare with previous version

Deploy Preview for webdev.eclipse.org-spec-host has failed [ 2 min 5 sec]

Inspect the build logs

Restart a deploy now

added 1 commit

• 7d1ecdcb - Add hugo to build script

Compare with previous version

Deploy Preview for webdev.eclipse.org-spec-host is ready [ 3 min 2 sec]

Inspect the build logs

Test locally docker run -it --rm -p 18181:8080 docker.io/eclipsefdn/webdev-eclipse-org-spec-host:mr-1--7d1ecdc-b8 and open to http://localhost:18181

Browse the preview: https://preview-1--webdev-eclipse-org-spec-host.eclipsecontent.org/docs/api

added 1 commit

• 0be41a84 - Use relURL instead of absURL to avoid issues w/ preview

Compare with previous version

Deploy Preview for webdev.eclipse.org-spec-host is ready [ 2 min 16 sec]

Inspect the build logs

Test locally docker run -it --rm -p 18181:8080 docker.io/eclipsefdn/webdev-eclipse-org-spec-host:mr-1--0be41a8-b9 and open to http://localhost:18181

Browse the preview: https://preview-1--webdev-eclipse-org-spec-host.eclipsecontent.org/docs/api

added 2 commits

• c3efbd6d - Remove generated specs data file and ignore it
• 96ac6fbb - Update project resources/metadata, remove unneeded dockerfiles

Compare with previous version

Deploy Preview for webdev.eclipse.org-spec-host is ready [ 4 min 42 sec]

Inspect the build logs

Test locally docker run -it --rm -p 18181:8080 docker.io/eclipsefdn/webdev-eclipse-org-spec-host:mr-1--96ac6fb-b10 and open to http://localhost:18181

Browse the preview: https://preview-1--webdev-eclipse-org-spec-host.eclipsecontent.org/docs/api

added 1 commit

• c785eca5 - Add missing license file

Compare with previous version

marked this merge request as ready

requested review from @cguindon, @epoirier, @oliviergoulet, and @zacharysabourin

Deploy Preview for webdev.eclipse.org-spec-host is ready [ 5 min 3 sec]

Inspect the build logs

Test locally docker run -it --rm -p 18181:8080 docker.io/eclipsefdn/webdev-eclipse-org-spec-host:mr-1--c785eca-b11 and open to http://localhost:18181

Browse the preview: https://preview-1--webdev-eclipse-org-spec-host.eclipsecontent.org/docs/api

The most recent version is 2.0. Feel free to use the up-to-date version I've created in the profile-API here: https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-profile-api/-/blob/0ac79b1208ece6ed118684277d6acf80be52acac/CODE_OF_CONDUCT.md

It's based off the code of conduct from https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php

changed this line in version 10 of the diff

Otherwise LGTM!