migrate docs to Openlineage/Openlineage repo #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build & Deploy docs to Netlify GitHub Pages | ||
Check failure on line 1 in .github/workflows/docs-deploy.yml GitHub Actions / .github/workflows/docs-deploy.ymlInvalid workflow file
|
||
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 |