Skip to content

Commit

Permalink
migrate docs to Openlineage/Openlineage repo
Browse files Browse the repository at this point in the history
Signed-off-by: Pawel Leszczynski <[email protected]>
  • Loading branch information
pawel-big-lebowski committed Jul 22, 2024
1 parent 11b8e3b commit 9bb46cc
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build & Deploy docs to Netlify GitHub Pages

on:
push:
tags:
- '[0-9]+.[0-9]+.[0-9]+'
# QUESTION: will it be a problem for a CircleCI release workflow if this workflow starts modifying main branch?

jobs:
generate_java_doc:
# Generates java doc for Java client, add it to the repo under website/static/javadoc
# TODO: generate javadoc for java client to be generated
# https://github.com/marketplace/actions/update-files-on-github

generate_spec:
# generate https://github.com/OpenLineage/docs/tree/main/static/spec/2-0-1
# QUESTION: Is .last_spec_commit_id file necessary ?
# latest spec of the doc won't be contained in the static resources? QUESTION: is this a problem?

generate_openapi:
# TODO: https://github.com/OpenLineage/OpenLineage/blob/main/spec/release.sh
# TODO: need to run: https://github.com/OpenLineage/docs/blob/main/scripts/build-docs.sh
# why is this .last_spec_commit_id mechanism necessary?
# https://github.com/marketplace/actions/update-files-on-github


netlify_deploy: # https://github.com/marketplace/actions/netlify-deploy
# TODO: netlify token will be necessary
deploy:
name: 'Deploy to Netlify'
steps:
- uses: jsmrcaga/[email protected]
with:
NETLIFY_AUTH_TOKEN: ${{ secrets.MY_TOKEN_SECRET }}
NETLIFY_DEPLOY_TO_PROD: true # can be false for now


# TODO: move OpenLineage/docs repo content to /website within OpenLineage/OpenLineage
# remove build-docs -> https://github.com/OpenLineage/docs/blob/main/scripts/build-docs.sh
# remove this -> https://github.com/OpenLineage/docs/blob/main/.github/workflows/deploy.yml
# remove spec release -> https://github.com/OpenLineage/OpenLineage/blob/main/spec/release.sh

0 comments on commit 9bb46cc

Please sign in to comment.