Lucene.Net.Documentation #10
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
| # Licensed to the Apache Software Foundation (ASF) under one | |
| # or more contributor license agreements. See the NOTICE file | |
| # distributed with this work for additional information | |
| # regarding copyright ownership. The ASF licenses this file | |
| # to you under the Apache License, Version 2.0 (the | |
| # "License"); you may not use this file except in compliance | |
| # with the License. You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, | |
| # software distributed under the License is distributed on an | |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| # KIND, either express or implied. See the License for the | |
| # specific language governing permissions and limitations | |
| # under the License. | |
| name: 'Lucene.Net.Documentation' | |
| # This will: | |
| # checkout this repo | |
| # get current or latest tag to parse a version for use in the docs | |
| # change to docs/VERSION branch | |
| # Build the docs | |
| # Checkout the website repo | |
| # Create a branch | |
| # Commit/Push to the branch | |
| # Create a PR | |
| # push the docs/VERSION branch | |
| on: | |
| workflow_dispatch: | |
| push: | |
| tags: | |
| - Docs_* | |
| #branches: | |
| #- master | |
| paths: | |
| - 'websites/apidocs/**/*' | |
| - 'src/docs/LuceneDocsPlugins/**/*' | |
| env: | |
| # If a tag is specified, the tag will be in the format: Docs_4_8_0_beta00013 | |
| # Or if not tag is specified, the latest Lucene.Net_4_8_0_beta00013 release tag will be used | |
| # which will be parsed to create the version number used in the docs like 4.8.0-beta00013 | |
| CURRENT_TAG: "NO-VERSION" | |
| RELEASE_VERSION: "(no tag)" | |
| SITE_REPO: "${{ github.repository }}-site" | |
| GIT_MAIN_REPO: "${{ github.workspace }}\\main-repo\\.git" | |
| jobs: | |
| build: | |
| runs-on: windows-latest | |
| steps: | |
| # Checkout the main repo with all history so we get all tags | |
| - name: Checkout Lucene.Net source | |
| uses: actions/checkout@v3 | |
| with: | |
| path: main-repo | |
| fetch-depth: 0 | |
| - name: Set version from tag | |
| run: | | |
| # initialize to SHA | |
| echo ("CURRENT_TAG=" + $Env:GITHUB_SHA) >> $env:GITHUB_ENV | |
| $ref = $Env:GITHUB_REF | |
| if ($ref.StartsWith("refs/tags/")) { | |
| $tag = $ref.Substring(10) | |
| echo "extracted tag name from refs/tags as $tag" | |
| } | |
| else { | |
| echo "Get the latest Lucene.Net_ tag" | |
| $tag = & git --git-dir "$Env:GIT_MAIN_REPO" tag --list --sort=-version:refname 'Lucene.Net_[0-9]_[0-9]_[0-9]*' | select -first 1 | |
| } | |
| if ($tag -eq $null) { | |
| echo "::error::Could not determine current version tag" | |
| exit 1 | |
| } | |
| # write the environment var | |
| echo ("CURRENT_TAG=" + $tag) >> $env:GITHUB_ENV | |
| $parts = $tag.Split("_") | |
| $version = ''; | |
| For ($i=1; $i -le $parts.Length; $i++) { | |
| $version += $parts[$i] | |
| if ($i -eq ($parts.Length - 2)) { | |
| $version += "-" | |
| } | |
| elseif ($i -lt ($parts.Length - 1)) { | |
| $version += "." | |
| } | |
| } | |
| if ($version -ne '') { | |
| # the tag parsed to the correct version format, write the environment var | |
| echo ("RELEASE_VERSION=" + $version) >> $env:GITHUB_ENV | |
| } | |
| else { | |
| echo "::error::Could not parse current version tag" | |
| exit 1 | |
| } | |
| shell: powershell | |
| - name: Verify environment variables | |
| run: | | |
| echo "CURRENT_TAG=$Env:CURRENT_TAG" | |
| echo "RELEASE_VERSION=$Env:RELEASE_VERSION" | |
| shell: powershell | |
| - name: Change branch | |
| run: | | |
| git --git-dir "$Env:GIT_MAIN_REPO" checkout -b "docs/${{ env.RELEASE_VERSION }}" | |
| shell: powershell | |
| - name: Setup .NET 6 SDK | |
| uses: actions/setup-dotnet@v3 | |
| with: | |
| dotnet-version: '6.0.x' | |
| - name: Setup .NET 8 SDK | |
| uses: actions/setup-dotnet@v3 | |
| with: | |
| dotnet-version: '8.0.x' | |
| - name: Install docfx globally | |
| run: dotnet tool install --global docfx --version 2.77.0 | |
| shell: powershell | |
| - name: Set up PATH for global tools | |
| shell: pwsh | |
| run: | | |
| $env:PATH += ";$HOME/.dotnet/tools" | |
| Write-Host "Updated PATH: $env:PATH" | |
| - name: Build docs | |
| run: ./main-repo/websites/apidocs/docs.ps1 -Clean -LuceneNetVersion ${{ env.RELEASE_VERSION }} | |
| shell: powershell | |
| - name: Checkout Lucene.Net website | |
| uses: actions/checkout@v3 | |
| with: | |
| repository: ${{ env.SITE_REPO }} | |
| ref: asf-site | |
| path: website-repo | |
| - name: Copy documentation site files | |
| run: Get-ChildItem -Path "$Env:GITHUB_WORKSPACE\main-repo\websites\apidocs\_site" | Copy-Item -Destination "$Env:GITHUB_WORKSPACE\website-repo\docs\$Env:RELEASE_VERSION" -Recurse -Force | |
| shell: powershell | |
| # Always push to the same branch based on the CURRENT_TAG (latest version tag) | |
| # Because we are always building the docs against a consistent version | |
| - name: Create Pull Request | |
| id: cpr | |
| uses: peter-evans/create-pull-request@v5 | |
| with: | |
| token: ${{ secrets.LUCENE_NET_WEBSITE_BUILD }} | |
| path: website-repo | |
| commit-message: New documentation version built | |
| committer: GitHub <[email protected]> | |
| author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> | |
| branch: ${{ env.CURRENT_TAG }} | |
| delete-branch: true | |
| title: 'New documentation version built ${{ env.CURRENT_TAG }}' | |
| body: | | |
| New documentation version built ${{ env.CURRENT_TAG }} | |
| - For version ${{ env.RELEASE_VERSION }} | |
| - name: Check outputs | |
| run: | | |
| echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" | |
| echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" | |
| # TODO: Commit and push docs branch |