New readme with quick start #383
Workflow file for this run
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 Doc CI | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| branches: | |
| - main | |
| - preview/docs | |
| paths: | |
| - 'README.md' | |
| - 'docs/**' | |
| - 'scripts/docs/**' | |
| - '.github/workflows/build_doc_ci.yml' | |
| env: | |
| packageSetupType: promptflow_with_extra | |
| testWorkingDirectory: ${{ github.workspace }}/src/promptflow | |
| condaEnvName: release-env | |
| jobs: | |
| build_doc_job: | |
| runs-on: windows-latest | |
| name: Build Doc | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v2 | |
| with: | |
| submodules: true | |
| - name: Build Doc | |
| shell: powershell | |
| working-directory: scripts/docs/ | |
| run: ./doc_generation.ps1 -WarningAsError:$true | |
| # Note: We have this job separately because some error may missing when build link check exists. | |
| link_check_job: | |
| runs-on: windows-latest | |
| name: Build Link Check | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v2 | |
| with: | |
| submodules: true | |
| - name: Build LinkCheck | |
| shell: powershell | |
| working-directory: scripts/docs/ | |
| run: ./doc_generation.ps1 -BuildLinkCheck -WarningAsError:$true | |
| # TODO: Once we fixed all warnings in reference doc job, delete this whole job and make job "build_doc_job" to run with "-WithReferenceDoc:$true" | |
| build_doc_with_reference_doc_job: | |
| runs-on: windows-latest | |
| name: Build Doc with Reference Doc | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v2 | |
| with: | |
| submodules: true | |
| - name: Conda Setup | |
| uses: "./.github/actions/step_create_conda_environment" | |
| - name: Dev setup | |
| uses: "./.github/actions/step_sdk_setup" | |
| with: | |
| setupType: ${{ env.packageSetupType }} | |
| scriptPath: ${{ env.testWorkingDirectory }} | |
| - name: Build doc with reference doc | |
| shell: powershell | |
| working-directory: scripts/docs/ | |
| run: |- | |
| conda activate ${{ env.condaEnvName }} | |
| pip install langchain | |
| ./doc_generation.ps1 -WithReferenceDoc:$true |