-
Notifications
You must be signed in to change notification settings - Fork 96
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docs GitHub Actions for 4.1.2 #511
Closed
jelovirt
wants to merge
2
commits into
feature/update-ci-configuration
from
release/github-actions-4.1.2
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,6 @@ | ||
| # This workflow builds changes to release tag and commits to website repo for release PR | ||
|
|
||
| name: Generate website release PR | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
|
|
@@ -13,106 +12,134 @@ on: | |
| required: true | ||
| repository_dispatch: | ||
| types: [release] | ||
|
|
||
| jobs: | ||
| deploy: | ||
| # deploy: | ||
| # runs-on: ubuntu-latest | ||
| # env: | ||
| # WEBSITE_PLUGIN_BRANCH: 'master' | ||
| # DITA_OT_VERSION: '4.0.1' | ||
| # steps: | ||
| # - name: Parse arguments | ||
| # run: | | ||
| # if [[ -n "${{ github.event.client_payload.dita_ot_version }}" ]]; then | ||
| # readonly TOKENS=($(echo "${{ github.event.client_payload.dita_ot_version }}" | tr '.' ' ')) | ||
| # else | ||
| # readonly TOKENS=($(echo "${{ github.event.inputs.dita-ot-version }}" | tr '.' ' ')) | ||
| # fi | ||
| # echo "RELEASE=${TOKENS[0]}.${TOKENS[1]}" >> $GITHUB_ENV | ||
| # if [[ -n "${{ github.event.client_payload.docs_tag }}" ]]; then | ||
| # echo "TAG=${{ github.event.client_payload.docs_tag }}" >> $GITHUB_ENV | ||
| # else | ||
| # echo "TAG=${{ github.event.inputs.docs-tag }}" >> $GITHUB_ENV | ||
| # fi | ||
| # | ||
| # - name: Check out docs | ||
| # uses: actions/checkout@v4 | ||
| # with: | ||
| # ref: ${{ env.TAG }} | ||
| # | ||
| # - name: Set variables | ||
| # run: | | ||
| # echo "GITHUB_SHA_SHORT=$(git rev-parse --short HEAD)" >> $GITHUB_ENV | ||
| # | ||
| # - name: Set up JDK 17 | ||
| # uses: actions/setup-java@v3 | ||
| # with: | ||
| # distribution: temurin | ||
| # java-version: 17 | ||
| # | ||
| # - name: Check out website | ||
| # uses: actions/checkout@v4 | ||
| # with: | ||
| # repository: dita-ot/website | ||
| # token: ${{ secrets.COMMITTER_TOKEN }} | ||
| # path: website | ||
| # | ||
| # - name: Download website plug-in | ||
| # run: | | ||
| # curl -sL https://github.com/dita-ot/org.dita-ot.html/archive/refs/heads/${{ env.WEBSITE_PLUGIN_BRANCH }}.zip -o org.dita-ot.html.zip | ||
| # | ||
| # - name: Cache render DITA-OT | ||
| # uses: actions/cache@v3 | ||
| # with: | ||
| # path: dita-ot-${{ env.DITA_OT_VERSION }} | ||
| # key: ${{ runner.os }}-dita-ot-${{ env.DITA_OT_VERSION }} | ||
| # - name: Download render DITA-OT | ||
| # run: | | ||
| # if [ ! -d "dita-ot-${{ env.DITA_OT_VERSION }}" ]; then | ||
| # curl -sL https://github.com/dita-ot/dita-ot/releases/download/${{ env.DITA_OT_VERSION }}/dita-ot-${{ env.DITA_OT_VERSION }}.zip -o dita-ot-${{ env.DITA_OT_VERSION }}.zip | ||
| # unzip dita-ot-${{ env.DITA_OT_VERSION }}.zip | ||
| # else | ||
| # echo "Use cached dita-ot-${{ env.DITA_OT_VERSION }}" | ||
| # fi | ||
| # dita-ot-${{ env.DITA_OT_VERSION }}/bin/dita install org.dita-ot.html.zip --force -v | ||
| # | ||
| # - name: Download release DITA-OT | ||
| # run: | | ||
| # curl -sL https://github.com/dita-ot/dita-ot/releases/download/$VERSION/dita-ot-$VERSION.zip -o dita-ot-$VERSION.zip | ||
| # unzip dita-ot-$VERSION.zip -d src-dita-ot | ||
| # env: | ||
| # VERSION: ${{ github.event.inputs.dita-ot-version }} | ||
| # | ||
| # - name: Run DITA-OT | ||
| # run: | | ||
| # ./gradlew site \ | ||
| # -PditaHome=$DITA_HOME \ | ||
| # -PoutputDir=$WEBSITE_DIR/${{ env.RELEASE }} \ | ||
| # -PditaHomeSrc=${{ env.RELEASE_DITA_OT }} \ | ||
| # -PnoCommitMeta=true \ | ||
| # --info --stacktrace --no-daemon | ||
| # env: | ||
| # VERSION: ${{ github.event.inputs.dita-ot-version }} | ||
| # WEBSITE_DIR: ${{ github.workspace }}/website | ||
| # DITA_HOME: ${{ github.workspace }}/dita-ot-${{ env.DITA_OT_VERSION }} | ||
| # RELEASE_DITA_OT: ${{ github.workspace }}/src-dita-ot/dita-ot-${{ github.event.inputs.dita-ot-version }} | ||
| # | ||
| # - name: Create release PR | ||
| # uses: peter-evans/create-pull-request@v5 | ||
| # with: | ||
| # branch: release/${{ github.event.inputs.dita-ot-version }} | ||
| # title: 'Update site for ${{ github.event.inputs.dita-ot-version }}' | ||
| # body: | | ||
| # Update DITA-OT ${{ github.event.inputs.dita-ot-version }} docs to `/${{ env.RELEASE }}`. | ||
| # | ||
| # Built from commits: | ||
| # * dita-ot/docs@${{ env.GITHUB_SHA_SHORT }} (${{ github.event.inputs.docs-tag }}) | ||
| # * dita-ot/dita-ot (${{ github.event.inputs.dita-ot-version }}) | ||
| # * dita-ot/org.dita-ot.html (${{ env.WEBSITE_PLUGIN_BRANCH }}) | ||
| # commit-message: 'Update ‘${{ env.RELEASE }}’ docs for ${{ github.event.inputs.dita-ot-version }}' | ||
| # committer: 'DITA-OT Bot <[email protected]>' | ||
| # signoff: true | ||
| # token: ${{ secrets.DOCS_RELEASE_TOKEN }} | ||
| # path: website | ||
| # labels: | | ||
| # release-updates | ||
| update-ci: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| WEBSITE_PLUGIN_BRANCH: 'master' | ||
| DITA_OT_VERSION: '4.0.1' | ||
| steps: | ||
| - name: Parse arguments | ||
| run: | | ||
| if [[ -n "${{ github.event.client_payload.dita_ot_version }}" ]]; then | ||
| readonly TOKENS=($(echo "${{ github.event.client_payload.dita_ot_version }}" | tr '.' ' ')) | ||
| else | ||
| readonly TOKENS=($(echo "${{ github.event.inputs.dita-ot-version }}" | tr '.' ' ')) | ||
| fi | ||
| echo "RELEASE=${TOKENS[0]}.${TOKENS[1]}" >> $GITHUB_ENV | ||
| if [[ -n "${{ github.event.client_payload.docs_tag }}" ]]; then | ||
| echo "TAG=${{ github.event.client_payload.docs_tag }}" >> $GITHUB_ENV | ||
| else | ||
| echo "TAG=${{ github.event.inputs.docs-tag }}" >> $GITHUB_ENV | ||
| fi | ||
|
|
||
| - name: Check out docs | ||
| uses: actions/checkout@v4 | ||
| - name: Update GitHub Actions release workflow | ||
| uses: mikefarah/yq@master | ||
| with: | ||
| ref: ${{ env.TAG }} | ||
|
|
||
| - name: Set variables | ||
| run: | | ||
| echo "GITHUB_SHA_SHORT=$(git rev-parse --short HEAD)" >> $GITHUB_ENV | ||
|
|
||
| - name: Set up JDK 17 | ||
| uses: actions/setup-java@v3 | ||
| with: | ||
| distribution: temurin | ||
| java-version: 17 | ||
|
|
||
| - name: Check out website | ||
| uses: actions/checkout@v4 | ||
| cmd: yq -i '.jobs.deploy.env.DITA_OT_VERSION = "${{ github.event.inputs.dita-ot-version }}"' '.github/workflows/release.yml' | ||
| - name: Update GitHub Actions render action | ||
| uses: mikefarah/yq@master | ||
| with: | ||
| repository: dita-ot/website | ||
| token: ${{ secrets.COMMITTER_TOKEN }} | ||
| path: website | ||
|
|
||
| - name: Download website plug-in | ||
| run: | | ||
| curl -sL https://github.com/dita-ot/org.dita-ot.html/archive/refs/heads/${{ env.WEBSITE_PLUGIN_BRANCH }}.zip -o org.dita-ot.html.zip | ||
|
|
||
| - name: Cache render DITA-OT | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: dita-ot-${{ env.DITA_OT_VERSION }} | ||
| key: ${{ runner.os }}-dita-ot-${{ env.DITA_OT_VERSION }} | ||
| - name: Download render DITA-OT | ||
| run: | | ||
| if [ ! -d "dita-ot-${{ env.DITA_OT_VERSION }}" ]; then | ||
| curl -sL https://github.com/dita-ot/dita-ot/releases/download/${{ env.DITA_OT_VERSION }}/dita-ot-${{ env.DITA_OT_VERSION }}.zip -o dita-ot-${{ env.DITA_OT_VERSION }}.zip | ||
| unzip dita-ot-${{ env.DITA_OT_VERSION }}.zip | ||
| else | ||
| echo "Use cached dita-ot-${{ env.DITA_OT_VERSION }}" | ||
| fi | ||
| dita-ot-${{ env.DITA_OT_VERSION }}/bin/dita install org.dita-ot.html.zip --force -v | ||
|
|
||
| - name: Download release DITA-OT | ||
| run: | | ||
| curl -sL https://github.com/dita-ot/dita-ot/releases/download/$VERSION/dita-ot-$VERSION.zip -o dita-ot-$VERSION.zip | ||
| unzip dita-ot-$VERSION.zip -d src-dita-ot | ||
| env: | ||
| VERSION: ${{ github.event.inputs.dita-ot-version }} | ||
|
|
||
| - name: Run DITA-OT | ||
| run: | | ||
| ./gradlew site \ | ||
| -PditaHome=$DITA_HOME \ | ||
| -PoutputDir=$WEBSITE_DIR/${{ env.RELEASE }} \ | ||
| -PditaHomeSrc=${{ env.RELEASE_DITA_OT }} \ | ||
| -PnoCommitMeta=true \ | ||
| --info --stacktrace --no-daemon | ||
| env: | ||
| VERSION: ${{ github.event.inputs.dita-ot-version }} | ||
| WEBSITE_DIR: ${{ github.workspace }}/website | ||
| DITA_HOME: ${{ github.workspace }}/dita-ot-${{ env.DITA_OT_VERSION }} | ||
| RELEASE_DITA_OT: ${{ github.workspace }}/src-dita-ot/dita-ot-${{ github.event.inputs.dita-ot-version }} | ||
|
|
||
| cmd: yq -i '.inputs.DITA_OT_VERSION.default = "${{ github.event.inputs.dita-ot-version }}"' '.github/actions/render/action.yml' | ||
| - name: Create release PR | ||
| uses: peter-evans/create-pull-request@v5 | ||
| with: | ||
| branch: release/${{ github.event.inputs.dita-ot-version }} | ||
| title: 'Update site for ${{ github.event.inputs.dita-ot-version }}' | ||
| branch: release/github-actions-${{ github.event.inputs.dita-ot-version }} | ||
| title: 'Update docs GitHub Actions for ${{ github.event.inputs.dita-ot-version }}' | ||
| body: | | ||
| Update DITA-OT ${{ github.event.inputs.dita-ot-version }} docs to `/${{ env.RELEASE }}`. | ||
|
|
||
| Built from commits: | ||
| * dita-ot/docs@${{ env.GITHUB_SHA_SHORT }} (${{ github.event.inputs.docs-tag }}) | ||
| * dita-ot/dita-ot (${{ github.event.inputs.dita-ot-version }}) | ||
| * dita-ot/org.dita-ot.html (${{ env.WEBSITE_PLUGIN_BRANCH }}) | ||
| commit-message: 'Update ‘${{ env.RELEASE }}’ docs for ${{ github.event.inputs.dita-ot-version }}' | ||
| Update docs GitHub Actions for ${{ github.event.inputs.dita-ot-version }}. | ||
| commit-message: 'Update GitHub Actions for ${{ github.event.inputs.dita-ot-version }}' | ||
| committer: 'DITA-OT Bot <[email protected]>' | ||
| signoff: true | ||
| token: ${{ secrets.COMMITTER_TOKEN }} | ||
| path: website | ||
| token: ${{ secrets.DOCS_RELEASE_TOKEN }} | ||
| labels: | | ||
| release-updates | ||
| deploy: | ||
| env: | ||
| DITA_OT_VERSION: 4.1.2 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@infotexture The YAML editing tool (https://mikefarah.gitbook.io/yq/usage/github-action) seems to remove the empty lines from YAML. Seems this cannot be disabled. I'm ok with it removing them.