Merge pull request #6 from vroncevic/dev

sync

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,32 +7,4 @@ assignees: vroncevic
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,14 +7,4 @@ assignees: vroncevic
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

.github/workflows/gen_pm_docker_checker.yml

@@ -0,0 +1,22 @@
+name: gen_pm docker checker
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build Docker image
+      id: docker_checker
+      run: |
+        echo Building Docker image
+        build_transcript=$(docker build . --file Dockerfile --tag gen_pm:latest)
+        [[ "$build_transcript" == *"Successfully"* ]] && echo ::set-output name=status::success || echo ::set-output name=status::failure
+    - name: Check on failures
+      if: steps.docker_checker.outputs.status == 'failure'
+      run: exit 1

.github/workflows/gen_pm_shell_checker.yml

@@ -0,0 +1,25 @@
+name: gen_pm shell checker
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Check syntax script
+        id: syntax_checker
+        run: bash -n sh_tool/bin/gen_pm.sh && echo ::set-output name=status::success || echo ::set-output name=status::failure
+      - name: Check size script
+        id: size_checker
+        run: |
+          echo Checking size
+          code_line_number=$(wc -l < sh_tool/bin/gen_pm.sh)
+          [[ $code_line_number -gt 300 ]] && echo ::set-output name=status::failure || echo ::set-output name=status::success
+      - name: Check on failures
+        if: steps.syntax_checker.outputs.status == 'failure' || steps.size_checker.outputs.status == 'failure'
+        run: exit 1

.github/workflows/gen_pm_toc.yaml

@@ -0,0 +1,10 @@
+name: gen_pm toc
+
+on: push
+
+jobs:
+  generateTOC:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+    steps:
+      - uses: technote-space/toc-generator@v2

.gitignore

@@ -1,24 +1,5 @@
 __pycache__/
 *.py[cod]
 *$py.class
-.Python
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-*.manifest
-*.spec
-.python-version
 .idea/
 .vscode/

README.md

@@ -1,28 +1,31 @@
-# Generating Perl Package Module.
+# Generating Perl Package Module
 
 **gen_pm** is shell tool for generating Perl package.
 
-Developed in [bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) code: **100%**.
+Developed in **[bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** code: **100%**.
+
+[![gen_pm shell checker](https://github.com/vroncevic/gen_pm/workflows/gen_pm%20shell%20checker/badge.svg)](https://github.com/vroncevic/gen_pm/actions?query=workflow%3A%22gen_pm+shell+checker%22)
 
 The README is used to introduce the tool and provide instructions on
 how to install the tool, any machine dependencies it may have and any
 other information that should be provided before the tool is installed.
 
-[![GitHub issues open](https://img.shields.io/github/issues/vroncevic/gen_pm.svg)](https://github.com/vroncevic/gen_pm/issues)
- [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/gen_pm.svg)](https://github.com/vroncevic/gen_pm/graphs/contributors)
+[![GitHub issues open](https://img.shields.io/github/issues/vroncevic/gen_pm.svg)](https://github.com/vroncevic/gen_pm/issues) [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/gen_pm.svg)](https://github.com/vroncevic/gen_pm/graphs/contributors)
 
-<!-- START doctoc -->
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
 - [Installation](#installation)
 - [Usage](#usage)
 - [Dependencies](#dependencies)
 - [Shell tool structure](#shell-tool-structure)
 - [Docs](#docs)
-- [Copyright and Licence](#copyright-and-licence)
-<!-- END doctoc -->
+- [Copyright and licence](#copyright-and-licence)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-### INSTALLATION
+### Installation
 
 Navigate to release [page](https://github.com/vroncevic/gen_pm/releases) download and extract release archive.
 
@@ -40,7 +43,9 @@ cp -R ~/sh_tool/log/   /root/scripts/gen_pm/ver.1.0/
 
 Or You can use docker to create image/container.
 
-### USAGE
+[![gen_pm docker checker](https://github.com/vroncevic/gen_pm/workflows/gen_pm%20docker%20checker/badge.svg)](https://github.com/vroncevic/gen_pm/actions?query=workflow%3A%22gen_pm+docker+checker%22)
+
+### Usage
 
 ```
 # Create symlink for shell tool
@@ -53,12 +58,12 @@ export PATH=${PATH}:/root/bin/
 gen_pm SimplePlTool
 ```
 
-### DEPENDENCIES
+### Dependencies
 
 **gen_pm** requires next modules and libraries:
 * sh_util [https://github.com/vroncevic/sh_util](https://github.com/vroncevic/sh_util)
 
-### SHELL TOOL STRUCTURE
+### Shell tool structure
 
 **gen_pm** is based on MOP.
 
@@ -74,21 +79,21 @@ Code structure:
     └── gen_pm.log
 ```
 
-### DOCS
+### Docs
 
 [![Documentation Status](https://readthedocs.org/projects/gen_pm/badge/?version=latest)](https://gen_pm.readthedocs.io/projects/gen_pm/en/latest/?badge=latest)
 
 More documentation and info at:
 * [https://gen_pm.readthedocs.io/en/latest/](https://gen_pm.readthedocs.io/en/latest/)
 * [https://www.gnu.org/software/bash/manual/](https://www.gnu.org/software/bash/manual/)
 
-### COPYRIGHT AND LICENCE
+### Copyright and licence
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Copyright (C) 2016 by [vroncevic.github.io/gen_pm](https://vroncevic.github.io/gen_pm)
 
-This tool is free software; you can redistribute it and/or modify
+**gen_pm** is free software; you can redistribute it and/or modify
 it under the same terms as Bash itself, either Bash version 4.2.47 or,
 at your option, any later version of Bash 4 you may have available.
 

docs/build/html/_sources/index.rst.txt

@@ -1,15 +1,15 @@
-GEN_PM
+gen_pm
 -------
 
-.. toctree::
- :hidden:
-
- self
-
 **gen_pm** is shell tool for generating Perl package.
 
 Developed in `bash <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`_ code: **100%**.
 
+|GitHub shell checker|
+
+.. |GitHub shell checker| image:: https://github.com/vroncevic/gen_pm/workflows/gen_pm%20shell%20checker/badge.svg
+   :target: https://github.com/vroncevic/gen_pm/actions?query=workflow%3A%22gen_pm+shell+checker%22
+
 The README is used to introduce the tool and provide instructions on
 how to install the tool, any machine dependencies it may have and any
 other information that should be provided before the tool is installed.
@@ -25,7 +25,12 @@ other information that should be provided before the tool is installed.
 .. |Documentation Status| image:: https://readthedocs.org/projects/gen_pm/badge/?version=latest
    :target: https://gen_pm.readthedocs.io/projects/gen_pm/en/latest/?badge=latest
 
-INSTALLATION
+.. toctree::
+    :hidden:
+
+    self
+
+Installation
 -------------
 
 Navigate to release `page`_ download and extract release archive.
@@ -42,13 +47,20 @@ To install **gen_pm** type the following:
    cp -R ~/sh_tool/conf/  /root/scripts/gen_pm/ver.1.0/
    cp -R ~/sh_tool/log/   /root/scripts/gen_pm/ver.1.0/
 
-DEPENDENCIES
+Or You can use Docker to create image/container.
+
+|GitHub docker checker|
+
+.. |GitHub docker checker| image:: https://github.com/vroncevic/gen_pm/workflows/gen_pm%20docker%20checker/badge.svg
+   :target: https://github.com/vroncevic/gen_pm/actions?query=workflow%3A%22gen_pm+docker+checker%22
+
+Dependencies
 -------------
 
 **gen_pm** requires next modules and libraries:
     sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_
 
-SHELL TOOL STRUCTURE
+Shell tool structure
 ---------------------
 
 **gen_pm** is based on MOP.
@@ -66,7 +78,7 @@ Code structure:
    └── log/
        └── gen_pm.log
 
-COPYRIGHT AND LICENCE
+Copyright and licence
 ----------------------
 
 |License: GPL v3| |License: Apache 2.0|
@@ -79,7 +91,7 @@ COPYRIGHT AND LICENCE
 
 Copyright (C) 2016 by `vroncevic.github.io/gen_pm <https://vroncevic.github.io/gen_pm>`_
 
-This tool is free software; you can redistribute it and/or modify it
+**gen_pm** is free software; you can redistribute it and/or modify it
 under the same terms as Bash itself, either Bash version 4.2.47 or,
 at your option, any later version of Bash 4 you may have available.