errose28 commented on code in PR #6916:
URL: https://github.com/apache/ozone/pull/6916#discussion_r1742327166
##########
.github/workflows/ci.yml:
##########
@@ -166,6 +166,99 @@ jobs:
path: |
~/.m2/repository/org/apache/ozone
retention-days: 1
+ build-config-doc:
+ needs:
+ - build
+ runs-on: ubuntu-20.04
+ steps:
+ - name: Checkout project
+ uses: actions/checkout@v4
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.x'
+ - name: Download the source artifact
+ uses: actions/download-artifact@v4
+ with:
+ name: ozone-bin
+ path: ozone-bin
+ - name: Extract the source tarball
+ run: |
+ mkdir -p ozone-bin/extracted
+ tar -xzf ozone-bin/ozone-*-SNAPSHOT.tar.gz -C ozone-bin/extracted
+ - name: Calculate hash of the existing Configurations.md
+ id: existing-hash
+ run: |
+ if [ -f hadoop-hdds/docs/content/tools/Configurations.md ]; then
+ sha256sum hadoop-hdds/docs/content/tools/Configurations.md | awk
'{ print $1 }' > existing_hash.txt
+ else
+ echo "No existing file found." > existing_hash.txt
+ fi
+ - name: Run the Python script to convert XML properties into Markdown
+ run: python3 dev-support/ci/xml_to_md.py ozone-bin/extracted >
hadoop-hdds/docs/content/tools/Configurations.md
+ - name: Calculate hash of the new Configurations.md
+ id: new-hash
+ run: sha256sum hadoop-hdds/docs/content/tools/Configurations.md | awk
'{ print $1 }' > new_hash.txt
+ - name: Compare hashes and decide to commit
+ id: hash-check
+ run: |
+ EXISTING_HASH=$(cat existing_hash.txt)
+ NEW_HASH=$(cat new_hash.txt)
+ if [ "$EXISTING_HASH" != "$NEW_HASH" ]; then
+ echo "Configurations.md has changed, proceeding to commit and
create PRs."
+ echo "hashes_differ=true" >> $GITHUB_ENV
+ else
+ echo "Configurations.md is unchanged, skipping commit and PR
creation."
+ echo "hashes_differ=false" >> $GITHUB_ENV
+ fi
+ - name: Commit and push changes to apache/ozone
+ if: env.hashes_differ == 'true'
+ run: |
+ git config --global user.name 'Github Actions'
+ git config --global user.email '[email protected]'
+ git add hadoop-hdds/docs/content/tools/Configurations.md
+ git commit -m "[Auto] Update Configurations.md from $GITHUB_SHA"
+ git push origin HEAD:master
+ - name: Create Pull Request in apache/ozone
+ if: env.hashes_differ == 'true'
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: |
+ gh pr create --title "[Auto] Update Configurations.md" --body "This
is an automated pull request."
Review Comment:
Github provides metadata about the event that triggered the action. See
[context](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context).
This will be helpful to have in the PR description. For example:
```
This is an automated pull request to update the website documentation of
Ozone's default configuration. It was triggered by the workflow {{
github.workflow }} run on {{ github.ref_name }}. Please delete the
$SOURCE_BRANCH branch from the repo when the PR is merged or closed.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
