Limit the timing of git submodule updates by renovate to avoid disrupting work during working hours #3
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: Generate code and open pull request | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| merge_group: | |
| jobs: | |
| tests: | |
| name: Generate OpenAPI based code | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Setup | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Update submodules | |
| run: git submodule update --remote --recursive | |
| - uses: actions/setup-node@v4 | |
| id: setup_node_id | |
| with: | |
| node-version: 18 | |
| - uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: 8.2 | |
| # Install openapi-generator-cli | |
| - run: echo "OPENAPI_GENERATOR_VERSION=7.10.0" >> $GITHUB_ENV | |
| - uses: actions/cache@v4 | |
| id: openapi-generator-cache | |
| env: | |
| cache-name: openapi-generator-cache | |
| with: | |
| path: ~/bin/openapitools | |
| key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ env.OPENAPI_GENERATOR_VERSION }} | |
| - if: steps.openapi-generator-cache.outputs.cache-hit != 'true' | |
| run: | | |
| mkdir -p ~/bin/openapitools | |
| curl https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/bin/utils/openapi-generator-cli.sh > ~/bin/openapitools/openapi-generator-cli | |
| chmod u+x ~/bin/openapitools/openapi-generator-cli | |
| export PATH=$PATH:~/bin/openapitools/ | |
| OPENAPI_GENERATOR_VERSION=${{ env.OPENAPI_GENERATOR_VERSION }} openapi-generator-cli version | |
| - name: Generate codes | |
| run: | | |
| export PATH=$PATH:~/bin/openapitools/ | |
| bash tools/gen-oas-client.sh | |
| - name: Update document | |
| run: | | |
| wget https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.3.1/phpDocumentor.phar | |
| php phpDocumentor.phar run -d src -t docs | |
| - run: | | |
| diff=$(git --no-pager diff --name-only HEAD) | |
| echo "DIFF_IS_EMPTY=$([[ -z "$diff" ]] && echo 'true' || echo 'false')" >> $GITHUB_ENV | |
| echo "CURRENT_DATETIME=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_ENV | |
| ## Run if diff exists and pull request, and make CI status failure (but allow renovate bot) | |
| - if: ${{ github.event_name == 'pull_request' && env.DIFF_IS_EMPTY != 'true' && github.actor != 'renovate[bot]' }} | |
| run: | | |
| echo "There are changes in the generated codes. Please run 'generate-code.py' and commit the changes." >&2 | |
| echo "The files with differences are as follows." >&2 | |
| echo "$(git --no-pager diff --name-only HEAD)" >&2 | |
| exit 1 | |
| ## Run if diff exists and event is not pull request, and make PR | |
| - if: ${{ github.event_name != 'pull_request' && env.DIFF_IS_EMPTY != 'true' }} | |
| run: | | |
| # Determine Change Type via Submodule Script. This scripts read current uncommited changes. | |
| CHANGE_TYPE=$(npx zx ./line-openapi/tools/determine-change-type.mjs) | |
| echo "Determined change type: $CHANGE_TYPE" | |
| # Determine PR title and body | |
| if [ "$CHANGE_TYPE" == "submodule-update" ]; then | |
| # Fetch PR info from submodule | |
| npx zx ./line-openapi/tools/get-pr-info.mjs | |
| PR_INFO=$(cat pr_info.json) | |
| TITLE=$(echo "$PR_INFO" | jq -r '.title') | |
| BODY=$(echo "$PR_INFO" | jq -r '.url')$'\n\n'$(echo "$PR_INFO" | jq -r '.body') | |
| else | |
| # Default PR title and body | |
| TITLE="Codes are generated by openapi generator" | |
| BODY="⚠Reviewer: Please edit this description to include relevant information about the changes.⚠" | |
| fi | |
| # Create PR | |
| BRANCH_NAME="update-diff-${{ env.CURRENT_DATETIME }}" | |
| git config user.name github-actions | |
| git config user.email [email protected] | |
| git checkout -b $BRANCH_NAME | |
| git add line-openapi | |
| git add src/** | |
| git commit --allow-empty -m "Codes are generated by openapi generator" | |
| git add docs/** | |
| git commit --allow-empty -m "Update document" | |
| git push origin $BRANCH_NAME | |
| gh pr create -B ${{ github.ref_name }} -H $BRANCH_NAME -t "$TITLE" -b "$BODY" --label "line-openapi-update" | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |