Create word artifact when a PR is merged to the main branch (#971)

* Generate the word doc as an artifact.

Add a workflow to generate the word doc and upload it as an artifact.

* updated deprecated commands.

`::set-output` is being deprecated. Replace it with `status=` syntax.

* Report status from converter run

* add an id

* YAML syntax

* reorder steps

* specify the shell

* path fixes

* remove unused array declaration

This isn't used by the tool, it reads all files in the folder, so just remove it.

Also, use the folder variable, rather than the hard-coded string.

Author: BillWagner

.github/workflows/update-on-merge.yaml

@@ -5,8 +5,9 @@ name: Update spec on merge
 on: 
   push:
     branches:
-      - draft-v6
-      - draft-v7
+      - standard-v6
+      - standard-v7
+      - draft-v8
   workflow_dispatch:
     inputs:
       reason:
@@ -63,5 +64,23 @@ jobs:
       uses: peter-evans/[email protected]
       if: ${{ steps.renumber-sections.outputs.status }} == 'success' && ${{ steps.update-grammar.outputs.status }} == 'success'
       with:
-        title: 'Automated Section renumber and grammar extraction'
-        body: 'renumber sections. Add grammar'
+        title: "Automated Section renumber and grammar extraction"
+        body: "renumber sections. Add grammar"
+
+    - name: Run converter
+      id: run-converter
+      run: |
+        cd tools
+        ./run-converter.sh
+      shell: bash
+
+    - name: Upload Word artifact
+      uses: actions/upload-artifact@v3
+      if: > 
+        ${{ steps.renumber-sections.outputs.status }} == 'success' && 
+        ${{ steps.update-grammar.outputs.status }} == 'success' && 
+        ${{ steps.run-converter.outputs.status }} == 'success'
+      with:
+        name: standard.docx
+        path: ./tools/tmp/standard.docx
+        retention-days: 15

tools/run-converter.sh

@@ -21,3 +21,11 @@ dotnet run --project $CONVERTER_PROJECT -- \
   $SPEC_DIRECTORY/*.md $TEMPLATE \
   -o $OUTPUT_DIRECTORY/standard.docx
 
+if [ "$?" -eq "0" ]
+then
+    # Success: Write key/value for GitHub action to read:
+    echo "status=success" >> $GITHUB_OUTPUT 
+else
+    # Failed: report the error to the GitHub action:
+    echo "status=failed" >> $GITHUB_OUTPUT 
+fi

tools/run-section-renumber.sh

@@ -14,8 +14,8 @@ dotnet run --project $PROJECT -- $1
 if [ "$?" -eq "0" ]
 then
     # Success: Write key/value for GitHub action to read:
-    echo "::set-output name=status::success" 
+    echo "status=success" >> $GITHUB_OUTPUT 
 else
     # Failed: report the error to the GitHub action:
-    echo "::set-output name=status::failed" 
+    echo "status=failed" >> $GITHUB_OUTPUT 
 fi

tools/run-smarten.sh

@@ -17,4 +17,4 @@ done
 rm -rf smarten
 
 # I think always success, but echo the success output anyway:
-echo "::set-output name=status::success" 
+echo "status=success" >> $GITHUB_OUTPUT

tools/update-grammar-annex.sh

@@ -49,4 +49,4 @@ echo Insert EOF Stuff
 cat $GRAMMAR_PROJECT/grammar-eof-insert.md >>$OUTPUT_FILE
 
 # I think always success, but echo the success output anyway:
-echo "::set-output name=status::success" 
+echo "status=success" >> $GITHUB_OUTPUT 

tools/validate-grammar.sh

@@ -3,28 +3,7 @@ set -eu -o pipefail
 
 declare -r SPEC_DIRECTORY=../standard
 
-declare -a SPEC_FILES=(
-    "lexical-structure.md" 
-    "basic-concepts.md" 
-    "types.md"
-    "variables.md"
-    "conversions.md"
-    "patterns.md"
-    "expressions.md"
-    "statements.md"
-    "namespaces.md"
-    "classes.md"
-    "structs.md"
-    "arrays.md"
-    "interfaces.md"
-    "enums.md"
-    "delegates.md"
-    "exceptions.md"
-    "attributes.md"
-    "unsafe-code.md"
-    )
-
-dotnet csharpgrammar ../test-grammar CSharp ../standard -m ../.github/workflows/dependencies/ReplaceAndAdd.md
+dotnet csharpgrammar ../test-grammar CSharp $SPEC_DIRECTORY -m ../.github/workflows/dependencies/ReplaceAndAdd.md
 
 # Now, validate it:
 curl -H "Accept: application/zip" https://repo1.maven.org/maven2/com/tunnelvisionlabs/antlr4/4.9.0/antlr4-4.9.0-complete.jar -o antlr-4.9.0-complete.jar