From 9bb46cc96d1f04d99c1205f4faebac76e5c5a0a9 Mon Sep 17 00:00:00 2001 From: Pawel Leszczynski Date: Mon, 22 Jul 2024 14:48:49 +0200 Subject: [PATCH] migrate docs to Openlineage/Openlineage repo Signed-off-by: Pawel Leszczynski --- .github/workflows/docs-deploy.yml | 41 +++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/docs-deploy.yml diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml new file mode 100644 index 0000000000..c0f3302918 --- /dev/null +++ b/.github/workflows/docs-deploy.yml @@ -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/action-netlify-deploy@v2.0.0 + 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 \ No newline at end of file