fix: update README to template (#1434) #66
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
| # Copyright 2024 Google LLC | |
| # | |
| # Licensed 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. | |
| # A workflow that updates the gh-pages branch whenever a new release is made | |
| name: Update documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| repository_dispatch: | |
| types: [gh-pages] | |
| workflow_dispatch: | |
| jobs: | |
| gh-page-sync: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| - name: Gradle Wrapper Validation | |
| uses: gradle/actions/wrapper-validation@v4 | |
| - name: Set up JDK 17 | |
| uses: actions/[email protected] | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' | |
| - name: Install Go | |
| uses: actions/setup-go@v4 | |
| with: | |
| go-version: '1.20' | |
| # Run dokka and create tar | |
| - name: Generate documentation | |
| run: | | |
| ./gradlew dokkaHtml | |
| echo "Creating tar for generated docs" | |
| cd $GITHUB_WORKSPACE/library/build/dokka/html && tar cvf ~/android-maps-utils-docs.tar . | |
| echo "Unpacking tar into gh-pages branch" | |
| git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/* | |
| go install github.com/google/addlicense@latest | |
| addlicense . | |
| cd $GITHUB_WORKSPACE && git checkout gh-pages && tar xvf ~/android-maps-utils-docs.tar | |
| # Commit changes and create a PR | |
| - name: PR Changes | |
| uses: peter-evans/create-pull-request@v6 | |
| with: | |
| token: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }} | |
| commit-message: 'docs: Update docs' | |
| author: googlemaps-bot <[email protected]> | |
| committer: googlemaps-bot <[email protected]> | |
| labels: | | |
| docs | |
| automerge | |
| title: 'docs: Update docs' | |
| body: | | |
| Updated GitHub pages with latest from `./gradlew dokkaHtml`. | |
| branch: googlemaps-bot/update_gh_pages |