Update Github Actions

.github/Customize_Instructions.md

@@ -0,0 +1,5 @@
+## Customize Instructions
+
+To customize the configure for individual project repo:
+1. Copy the config file from `.github/default` to `.github/custom` and make changes accordingly.
+2. You should not modify files inside `.github/default` and `.github/workflows`.

.github/auto_assign.yml

@@ -0,0 +1,21 @@
+# Set to true to add reviewers to pull requests
+addReviewers: true
+# Set to true to add assignees to pull requests
+addAssignees: false
+# A number of reviewers added to the pull request
+# Set 0 to add all the reviewers (default: 0)
+numberOfReviewers: 1
+# A number of assignees to add to the pull request
+# Set to 0 to add all of the assignees.
+# Uses numberOfReviewers if unset.
+# numberOfAssignees: 2
+# Set to true to add reviewers from different groups to pull requests
+useReviewGroups: true
+# A list of reviewers, split into different groups, to be added to pull requests (GitHub user name)
+reviewGroups:
+  groupQA:
+    - placeholder
+  groupDev:
+    - placeholder 
+# Set to true to add assignees from different groups to pull requests
+useAssigneeGroups: false

.github/default/pre_release_config.py

@@ -0,0 +1,40 @@
+CONFIG = {
+    "folder_analysis": {
+        "exclude_filenames": {
+            r"^\..*",
+            r"^__.*",
+            r"LICENSE.md",
+        },
+        "exclude_paths": {r"imgs"},
+    },
+    "readme": {
+        "mandatory_headings": {"Purpose", "Project Description"},
+        "mandatory_sections": {"License"},
+        "unnumbered_heading": {
+            "Purpose",
+            "Project Description",
+            "Table of Contents",
+        },
+        # Text line to force a exact match in final readme
+        # Add line no (from template) to the mandatory_lines
+        # use int or string as L3-4
+        "mandatory_lines": [
+            3,
+            4,
+        ],
+        # Text line to ignore
+        # Add line no (from template) here to suppress the warning
+        # use int or string as L3-4
+        "ignore_lines": [
+            "L6-8",
+            "L27-41",
+            "L143-204",
+            "L219-220",
+            "L225-227",
+        ],
+    },
+    "commented_code": {
+        # Lines does not count as commendted code
+        "special_lines": {"# -*- coding: utf-8 -*-"}
+    },
+}

.github/default/spellcheck.yaml

@@ -0,0 +1,26 @@
+# spellcheck.yaml
+matrix:
+- name: Markdown
+  expect_match: false
+  apsell:
+    mode: en
+  dictionary:
+    wordlists:
+    - wordlist.txt
+    output: wordlist.dic
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - markdown.extensions.extra:
+  - pyspelling.filters.html:
+      comments: true
+      attributes:
+      - title
+      - alt
+      ignores:
+      - ':matches(code, pre)'
+      - 'code'
+      - 'pre'
+  sources:
+  - '**/*.md'

.github/default/wordlist.txt

@@ -0,0 +1,109 @@
+accessable
+apis
+arn
+aws
+backend
+boolean
+boto
+broswer
+cli
+cloudformation
+cloudinary
+cloudwatch
+codebase
+codebases
+codepackage
+cpu
+creativecommons
+crontab
+css
+csvs
+cuda
+deployable
+depricated
+dev
+develpment
+discoverable
+dockerfile
+dropbox
+embeddings
+encyption
+enviroment
+exisitng
+facebook
+framerate
+github
+gmail
+gpu
+gpus
+graphdb
+html
+https
+ipynb
+javascript
+json
+jupyter
+jupyterlab
+juypter
+linux
+localhost
+macos
+manpages
+nlp
+nodejs
+notebbok
+npm
+nvidia
+opencv
+paramaters
+parametrized
+preprocess
+preprocessing
+pretrained
+pretraining
+py
+readme
+redistributions
+rekognition
+repo
+scientific's
+sdk
+serverless
+sfl
+subfolder
+submodule
+tensorflow
+terraform
+testcase
+tradeoffs
+txt
+ui
+unhashed
+unix
+vpc
+wsl
+yaml
+yml
+zipcode
+Ferrante
+Luk
+Segala
+config
+dataset
+resampling
+XGBoost
+NoDerivatives
+legalcode
+nd
+Licensor
+immunities
+Licensor
+enforceability
+merchantability
+Generis
+NonCommercial
+URI
+waivable
+ies
+WIPO
+synched

.github/pull_request_template.md

@@ -0,0 +1,25 @@
+# Description
+
+Please include a summary of the change. 
+Please also include relevant motivation and context. 
+List any dependencies that are required for this change.
+
+## Type of change (select all that apply)
+
+Please delete options that are not relevant.
+
+- [ ] Bug Fix
+- [ ] Iterative improvement or optimization
+- [ ] New Feature
+- [ ] Documentation update
+
+# Tests/QA
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce
+
+# Checklist:
+
+- [ ] Tests have been ran and everything still works
+- [ ] Code and other files are formatted to style guidelines
+- [ ] Code and other files pass automated checks for TODOs, typos etc
+- [ ] Documentation is updated as needed

.github/workflows/autoassign.yml

@@ -0,0 +1,28 @@
+name: Auto Assign yml updater
+on:
+  pull_request:
+    types: [opened reopened]
+jobs:
+  yamlupdate:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.head_ref }}
+    - name: before
+      run: cat .github/auto_assign.yml
+    - name: AutoBotYamlFileUpdater
+      uses: SFLScientific/AutoBotYaml@master
+      with:
+        token: ${{ secrets.SFLOrgReadAccessToken }}
+    - name: after
+      run: cat .github/auto_assign.yml
+    - name: Commit changes
+      uses: EndBug/add-and-commit@v4
+      with:
+        message: "Updated auto_assign.yml"
+        add: ".github/auto_assign.yml"
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+

.github/workflows/ipynb_to_md.yml

@@ -0,0 +1,25 @@
+name: IPYNB to MD
+# only run on notebook update
+on:
+  push:
+    branches-ignore: template-action-updates
+    paths:
+      - '**.ipynb'
+jobs:
+  makepdfs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.head_ref }}
+    - name: IPYNB to MD
+      uses: SFLScientific/IPYNB_to_MD@master
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v3.5.0
+      with:
+        commit-message: PR with converted to MD
+        committer: AutoCommit <example@users.noreply.github.com>
+        title: File conversions IPYNB to MD 
+        body: This is an auto-generated PR
+        labels: mds,pdfs, automated pr
+        branch: pynb-to-md-pdf-patches

.github/workflows/lint_markdown.yml

@@ -0,0 +1,19 @@
+name: Lint Markdown
+on: workflow_dispatch
+  # push:
+  #   branches-ignore: template-action-updates
+  #   paths:
+  #     - '**.md'
+jobs:
+  autopep8:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+      - name: Lint changelog file
+        uses: docker://avtodev/markdown-lint:v1
+        with:
+            rules: '/lint/rules/changelog.js'
+            config: '/lint/config/changelog.yml'
+            args: '**.md'

.github/workflows/md_to_pdf.yml

@@ -0,0 +1,44 @@
+name: MD to PDF
+# only run if .md updated
+on:
+  pull_request:
+    branches:
+      - main
+      - master
+    paths:
+      - '**.md'
+jobs:
+  makepdfs:
+    runs-on: ubuntu-latest
+    if: ${{ (github.repository != 'SFLScientific/SFL-Template') }}
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.head_ref }}
+    # converts all special chars to safe in the mds and makes backups
+    - name: Format trees in MDs
+      run: for F in $(find | grep -i "readme"); do cp $F $F.orig && sed -i 's/├/\+/g; s/│/\|/g;  s/─/-/g; s/└/\\/g' $F;done
+    - name: MD to PDF conversion
+      uses: SFLScientific/MDtoPDF@1.0.3
+    # move original mds back into place
+    - name: Move original MDs back
+      run: for F in $(find | grep -i ".md.orig"); do mv $F $(echo $F | sed 's/.orig//g') ;done
+    # remove all .pdf.orig pdfs that were untracked and not readme
+    - name: Remove .pdf.orig files
+      run: for pdf in $(find | grep ".pdf.orig"); do rm $pdf; done  
+    - name: Create Pull Request
+      id: cpr
+      uses: peter-evans/create-pull-request@v3.10.0
+      with:
+        commit-message: PR with converted to PDF
+        committer: AutoCommit <example@users.noreply.github.com>
+        title: File conversions MD_to_PDF
+        body: This is an auto-generated PR
+        labels: pdfs, automated pr
+        branch: ${{ format('md-to-pdf_{0}', github.head_ref) }}
+    - name: Merge Pull Request
+      uses: juliangruber/merge-pull-request-action@v1
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        number: ${{ steps.cpr.outputs.pull-request-number }}
+        method: squash