Merge pull request #69 from Heshdude/improving-automation

Adding automatic PR creation for generated README.md & installers.toml

Author: agentmilindu

.github/workflows/deploy.yml

@@ -11,25 +11,64 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@master
-      - name: Get the list of modified files only
+      - name: Get the list of modified installers only
         uses: technote-space/get-diff-action@v1
-      - name: Generate installers
-        run: pip install toml && python generate.py ${{ env.GIT_DIFF }}
+        with:
+          PREFIX_FILTER: |
+            installers/
+      - name: Generate installers, update README.md & installers.toml
+        if: env.GIT_DIFF
+        run: ./generate.sh ${{ env.GIT_DIFF }}
       - name: Minify generated installers
+        if: env.GIT_DIFF
         run: ./minify.sh ${{ env.GIT_DIFF }}
+      - name: Find the Related PR
+        if: env.GIT_DIFF
+        uses: jwalton/gh-find-current-pr@v1
+        id: findPr
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Related PR
+        if:  env.GIT_DIFF && success() && steps.findPr.outputs.number
+        id: vars
+        run: |
+          echo "The related PR is ${PR}"
+          echo ::set-output name=pr_id::"${PR}"
+        env:
+          PR: ${{ steps.findPr.outputs.pr }}
+      - name: Create a pull request for README.md & installers.toml updates
+        if: env.GIT_DIFF
+        uses: peter-evans/create-pull-request@v3
+        with:
+          commit-message: Update installer scripts, README.md & installers.toml
+          title: |
+            Update installer scripts, README.md & installers.toml for #${{ steps.vars.outputs.pr_id }}
+          body: |
+            Updated installer scripts, `README.md` & `installers.toml` according to the changes done in the `installer.toml`s.
+            This is a automatically generated PR in related to PR #${{ steps.vars.outputs.pr_id }}
+          branch: update-readme-md-and-installers-toml-${{ steps.vars.outputs.pr_id }}
+          labels: automated-pr, continious-delivery
       - name: Archive Production Artifact
+        if: env.GIT_DIFF
         uses: actions/upload-artifact@master
         with:
           name: installers
           path: installers
+
   deploy:
     name: Deploy
     needs: build
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
         uses: actions/checkout@master
+      - name: Get the list of modified installers only
+        uses: technote-space/get-diff-action@v1
+        with:
+          PREFIX_FILTER: |
+            installers/
       - name: Download Artifact
+        if: env.GIT_DIFF
         uses: actions/download-artifact@master
         with:
           name: installers

.github/workflows/dockerimage.yml

@@ -1,22 +1,22 @@
-
 name: Run tests
 
 on:
-
   push:
     branches: [ master ]
 
   pull_request:
     branches: [ master ]
 
-
 jobs:
 
   test-on-ubuntu:
-
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: technote-space/get-diff-action@v1
-    - name: Get the list of modified files only
-      run: pip install toml pytablewriter && python generate.py ${{ env.GIT_DIFF }} && docker build -t shellspec . && docker run -v $PWD:/app shellspec bash -c "cd /app && ./test.sh ${{ env.GIT_DIFF }}"
+      - uses: actions/checkout@v2
+      - uses: technote-space/get-diff-action@v1
+      - name: Run tests for the modified/ added files
+        run: |
+          pip install toml pytablewriter
+          python generate.py ${{ env.GIT_DIFF }}
+          docker build -t shellspec .
+          docker run -v $PWD:/app shellspec bash -c "cd /app && ./test.sh ${{ env.GIT_DIFF }}"

generate.py

@@ -31,7 +31,7 @@ def update_readme(summary):
         curl = "Yes" if "curl" in installers else "No"
         url = "https://installer.to/"+tool_shortname
         value_matrix.append([name, apt, yum, pacman, apk, dnf, curl, url])
-    print(value_matrix)
+
     writer.value_matrix = value_matrix
     table_md = writer.dumps()
     try:
@@ -46,32 +46,28 @@ def update_readme(summary):
             readme_md.write(readme)
             readme_md.close()
     except Error as e:
-        print(e)
+        logging.error('Error occurred when trying to update README.md, error: '+ e)
 
 
 def update_summary(name, shortname, description, installers):
     try:
         with open("./installers.toml", "r+") as installer_summary:
             summaary = installer_summary.read()
-            print (summaary)
             parsed_summary_toml = toml.loads(summaary)
-            print (parsed_summary_toml)
             if shortname not in parsed_summary_toml:
                 parsed_summary_toml[shortname] = {}
             parsed_summary_toml[shortname]['name'] = name
             parsed_summary_toml[shortname]['name'] = name
             parsed_summary_toml[shortname]['description'] = description
             parsed_summary_toml[shortname]['installers'] = ",".join(installers)
-            print (parsed_summary_toml)
             installer_summary.seek(0)  # sets  point at the beginning of the file
             installer_summary.truncate()  # Clear previous content
             installer_summary.write(toml.dumps(parsed_summary_toml))
             installer_summary.close()
 
             update_readme(parsed_summary_toml)
     except IOError as e:
-        print ("Error", e)
-        pass
+        logging.error('Error occurred when trying to update installers.toml, error: '+ e)
 
 def get_method_case(method):
    if method in methods:
@@ -167,7 +163,6 @@ def generate(path):
 
       installer_sh.close()
       update_summary(parsed_toml['name'], parsed_toml['shortname'], parsed_toml['description'], installer_methods)
-      print("installer_methods",installer_methods)
 
    except IOError as x:
       if x.errno == errno.EACCES:

generate.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+X=()
+
+for word in "$@"; do
+  X+=$(dirname "$word " | cut -d "/" -f "1 2")" "
+done
+
+CHANGED=$(echo $X | tr ' ' '\n' | sort | uniq | xargs)
+
+echo "generating for $CHANGED"
+pip install toml
+pip install pytablewriter
+python generate.py $CHANGED

installers/hlf/installer.toml

@@ -7,17 +7,16 @@ description = "Hyperledger Fabric"
 sh = """
 if ! command -v docker
 then
-    @warn "docker could not be found"
+    @warn "Docker could not be found"
     curl https://installer.to/docker | bash
 else
-    @info "docker found"
+    @info "Docker found"
 fi
 
-@info "downloading Fabric........"
+@info "Downloading Fabric........"
 curl -sSL http://bit.ly/2ysbOFE -o bootstrap.sh
 chmod 755 ./bootstrap.sh
 @sudo bash ./bootstrap.sh
 
 @sudo cp ./fabric-samples/bin/*    /usr/local/bin
-
 """