diff --git a/README.md b/README.md index 420557e..4fd2b07 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,27 @@ jobs: ERROR_EMAILS: example@example.com,example2@example.com ``` +### word_diff + +Word-diff creates a report of the changes to any .docx files between `main` and the current +pull request, after converting the files to markdown + +#### Usage + +```yml +on: + pull_request: + paths: + - '**/*.docx' + +jobs: + my-workflow: + ... + steps: + - uses: SuffolkLITLab/ALActions/word_diff@main +``` + + ## Development Details Using [codeql-action](https://github.com/github/codeql-action) as diff --git a/word_diff/action.yml b/word_diff/action.yml index fd1a04c..13ecf30 100644 --- a/word_diff/action.yml +++ b/word_diff/action.yml @@ -1,10 +1,7 @@ name: DOCX Diff - -on: - pull_request: - paths: - - '**/*.docx' - +description: | + This action compares DOCX files in a pull request with the base branch and generates a diff in HTML format. + The HTML diff files are uploaded as artifacts and can be viewed in the 'Artifacts' section of the workflow run. jobs: docx-diff: runs-on: ubuntu-latest