Skip to content

Commit ff2849a

Browse files
author
ADMSK\AVROGAL1
committed
docs: updates on workflows
Added information on documentation
1 parent 837e34b commit ff2849a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2113
-535
lines changed

‎.github/workflows/close_pr.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ jobs:
1818
- uses: actions/github@v1.0.0
1919
if: success()
2020
with:
21-
args: label "doesnt read directions"
21+
args: label "doesn't read directions"

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [0.0.0-dev](https://github.com/AlexRogalskiy/github-action-json-fields/compare/v2.0.1...v0.0.0-dev) (2021-04-05)
1+
# [0.0.0-dev](https://github.com/AlexRogalskiy/github-action-json-fields/compare/v2.0.1...v0.0.0-dev) (2021-04-11)
22

33

44

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@
3030
[![dependencies Status](https://status.david-dm.org/gh/AlexRogalskiy/github-action-json-fields.svg)](https://david-dm.org/AlexRogalskiy/github-action-json-fields)
3131
[![dependencies Status](https://status.david-dm.org/gh/AlexRogalskiy/github-action-json-fields.svg)](https://david-dm.org/AlexRogalskiy/github-action-json-fields?type=dev)
3232

33+
[![Total alerts](https://img.shields.io/lgtm/alerts/g/AlexRogalskiy/github-action-json-fields.svg?logo=lgtm\&logoWidth=18)](https://lgtm.com/projects/g/AlexRogalskiy/github-action-json-fields/alerts/)
34+
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/AlexRogalskiy/github-action-json-fields.svg?logo=lgtm\&logoWidth=18)](https://lgtm.com/projects/g/AlexRogalskiy/github-action-json-fields/context:javascript)
3335
[![codecov](https://codecov.io/gh/AlexRogalskiy/github-action-json-fields/branch/master/graph/badge.svg?token=MuiGSj3HFi)](https://codecov.io/gh/AlexRogalskiy/github-action-json-fields)
3436
[![CI](https://github.com/AlexRogalskiy/github-action-json-fields/workflows/CI/badge.svg)](https://github.com/AlexRogalskiy/github-action-json-fields/actions/workflows/build.yml)
3537
[![CircleCI](https://circleci.com/gh/AlexRogalskiy/github-action-json-fields.svg?style=shield)](https://circleci.com/gh/AlexRogalskiy/github-action-json-fields)

‎dist/index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/src_errors_errors.extendableerror.html‎ renamed to ‎docs/classes/src_errors_extendable_error.extendableerror.html‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@
5353
<a href="../modules.html">GitHub action for Json Fields processing</a>
5454
</li>
5555
<li>
56-
<a href="../modules/src_errors_errors.html">src/errors/errors</a>
56+
<a href="../modules/src_errors_extendable_error.html">src/errors/extendable.error</a>
5757
</li>
5858
<li>
59-
<a href="src_errors_errors.extendableerror.html">ExtendableError</a>
59+
<a href="src_errors_extendable_error.extendableerror.html">ExtendableError</a>
6060
</li>
6161
</ul>
6262
<h1>Class ExtendableError</h1>
@@ -88,7 +88,7 @@ <h3>Hierarchy</h3>
8888
<span class="target">ExtendableError</span>
8989
<ul class="tsd-hierarchy">
9090
<li>
91-
<a href="src_errors_errors.generalerror.html" class="tsd-signature-type" data-tsd-kind="Class">GeneralError</a>
91+
<a href="src_errors_general_error.generalerror.html" class="tsd-signature-type" data-tsd-kind="Class">GeneralError</a>
9292
</li>
9393
</ul>
9494
</li>
@@ -103,24 +103,24 @@ <h2>Index</h2>
103103
<section class="tsd-index-section ">
104104
<h3>Constructors</h3>
105105
<ul class="tsd-index-list">
106-
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="src_errors_errors.extendableerror.html#constructor" class="tsd-kind-icon">constructor</a></li>
106+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="src_errors_extendable_error.extendableerror.html#constructor" class="tsd-kind-icon">constructor</a></li>
107107
</ul>
108108
</section>
109109
<section class="tsd-index-section ">
110110
<h3>Properties</h3>
111111
<ul class="tsd-index-list">
112-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="src_errors_errors.extendableerror.html#message" class="tsd-kind-icon">message</a></li>
113-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="src_errors_errors.extendableerror.html#name" class="tsd-kind-icon">name</a></li>
114-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="src_errors_errors.extendableerror.html#preparestacktrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
115-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="src_errors_errors.extendableerror.html#stack" class="tsd-kind-icon">stack</a></li>
116-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="src_errors_errors.extendableerror.html#stacktracelimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
117-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="src_errors_errors.extendableerror.html#type" class="tsd-kind-icon">type</a></li>
112+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="src_errors_extendable_error.extendableerror.html#message" class="tsd-kind-icon">message</a></li>
113+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="src_errors_extendable_error.extendableerror.html#name" class="tsd-kind-icon">name</a></li>
114+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="src_errors_extendable_error.extendableerror.html#preparestacktrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
115+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="src_errors_extendable_error.extendableerror.html#stack" class="tsd-kind-icon">stack</a></li>
116+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="src_errors_extendable_error.extendableerror.html#stacktracelimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
117+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="src_errors_extendable_error.extendableerror.html#type" class="tsd-kind-icon">type</a></li>
118118
</ul>
119119
</section>
120120
<section class="tsd-index-section ">
121121
<h3>Methods</h3>
122122
<ul class="tsd-index-list">
123-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="src_errors_errors.extendableerror.html#capturestacktrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
123+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="src_errors_extendable_error.extendableerror.html#capturestacktrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
124124
</ul>
125125
</section>
126126
</div>
@@ -132,14 +132,14 @@ <h2>Constructors</h2>
132132
<a name="constructor" class="tsd-anchor"></a>
133133
<h3>constructor</h3>
134134
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
135-
<li class="tsd-signature tsd-kind-icon">new <wbr>Extendable<wbr>Error<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../enums/src_errors_errors.errortype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ErrorType</a>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="src_errors_errors.extendableerror.html" class="tsd-signature-type" data-tsd-kind="Class">ExtendableError</a></li>
135+
<li class="tsd-signature tsd-kind-icon">new <wbr>Extendable<wbr>Error<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../enums/typings_enum_types.errortype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ErrorType</a>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="src_errors_extendable_error.extendableerror.html" class="tsd-signature-type" data-tsd-kind="Class">ExtendableError</a></li>
136136
</ul>
137137
<ul class="tsd-descriptions">
138138
<li class="tsd-description">
139139
<aside class="tsd-sources">
140140
<p>Overrides Error.constructor</p>
141141
<ul>
142-
<li>Defined in <a href="https://github.com/AlexRogalskiy/github-action-json-fields/blob/aa4ac51/src/errors/errors.ts#L18">src/errors/errors.ts:18</a></li>
142+
<li>Defined in <a href="https://github.com/AlexRogalskiy/github-action-json-fields/blob/837e34b/src/errors/extendable.error.ts#L9">src/errors/extendable.error.ts:9</a></li>
143143
</ul>
144144
</aside>
145145
<div class="tsd-comment tsd-typography">
@@ -150,9 +150,9 @@ <h3>constructor</h3>
150150
<h4 class="tsd-parameters-title">Parameters</h4>
151151
<ul class="tsd-parameters">
152152
<li>
153-
<h5>type: <a href="../enums/src_errors_errors.errortype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ErrorType</a></h5>
153+
<h5>type: <a href="../enums/typings_enum_types.errortype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ErrorType</a></h5>
154154
<div class="tsd-comment tsd-typography">
155-
<p>initial input <a href="../enums/src_errors_errors.errortype.html">ErrorType</a></p>
155+
<p>initial input <a href="../enums/typings_enum_types.errortype.html">ErrorType</a></p>
156156
</div>
157157
</li>
158158
<li>
@@ -162,7 +162,7 @@ <h5>message: <span class="tsd-signature-type">string</span></h5>
162162
</div>
163163
</li>
164164
</ul>
165-
<h4 class="tsd-returns-title">Returns <a href="src_errors_errors.extendableerror.html" class="tsd-signature-type" data-tsd-kind="Class">ExtendableError</a></h4>
165+
<h4 class="tsd-returns-title">Returns <a href="src_errors_extendable_error.extendableerror.html" class="tsd-signature-type" data-tsd-kind="Class">ExtendableError</a></h4>
166166
</li>
167167
</ul>
168168
</section>
@@ -256,7 +256,7 @@ <h3>stack<wbr>Trace<wbr>Limit</h3>
256256
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
257257
<a name="type" class="tsd-anchor"></a>
258258
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3>
259-
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/src_errors_errors.errortype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ErrorType</a></div>
259+
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/typings_enum_types.errortype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ErrorType</a></div>
260260
<aside class="tsd-sources">
261261
</aside>
262262
</section>
@@ -312,7 +312,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
312312
<a href="../modules/src_constants_constants.html">src/constants/constants</a>
313313
</li>
314314
<li class="current tsd-kind-module">
315-
<a href="../modules/src_errors_errors.html">src/errors/errors</a>
315+
<a href="../modules/src_errors_extendable_error.html">src/errors/extendable.error</a>
316+
</li>
317+
<li class=" tsd-kind-module">
318+
<a href="../modules/src_errors_general_error.html">src/errors/general.error</a>
319+
</li>
320+
<li class=" tsd-kind-module">
321+
<a href="../modules/src_errors_value_error.html">src/errors/value.error</a>
316322
</li>
317323
<li class=" tsd-kind-module">
318324
<a href="../modules/src_utils_commons.html">src/utils/commons</a>
@@ -323,9 +329,15 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
323329
<li class=" tsd-kind-module">
324330
<a href="../modules/src_utils_files.html">src/utils/files</a>
325331
</li>
332+
<li class=" tsd-kind-module">
333+
<a href="../modules/src_utils_loggers.html">src/utils/loggers</a>
334+
</li>
326335
<li class=" tsd-kind-module">
327336
<a href="../modules/src_utils_profiles.html">src/utils/profiles</a>
328337
</li>
338+
<li class=" tsd-kind-module">
339+
<a href="../modules/src_utils_properties.html">src/utils/properties</a>
340+
</li>
329341
<li class=" tsd-kind-module">
330342
<a href="../modules/src_utils_serializers.html">src/utils/serializers</a>
331343
</li>
@@ -345,51 +357,39 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
345357
</nav>
346358
<nav class="tsd-navigation secondary menu-sticky">
347359
<ul class="before-current">
348-
<li class=" tsd-kind-enum tsd-parent-kind-module">
349-
<a href="../enums/src_errors_errors.errortype.html" class="tsd-kind-icon">Error<wbr>Type</a>
350-
</li>
351360
</ul>
352361
<ul class="current">
353362
<li class="current tsd-kind-class tsd-parent-kind-module">
354-
<a href="src_errors_errors.extendableerror.html" class="tsd-kind-icon">Extendable<wbr>Error</a>
363+
<a href="src_errors_extendable_error.extendableerror.html" class="tsd-kind-icon">Extendable<wbr>Error</a>
355364
<ul>
356365
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
357-
<a href="src_errors_errors.extendableerror.html#constructor" class="tsd-kind-icon">constructor</a>
366+
<a href="src_errors_extendable_error.extendableerror.html#constructor" class="tsd-kind-icon">constructor</a>
358367
</li>
359368
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
360-
<a href="src_errors_errors.extendableerror.html#message" class="tsd-kind-icon">message</a>
369+
<a href="src_errors_extendable_error.extendableerror.html#message" class="tsd-kind-icon">message</a>
361370
</li>
362371
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
363-
<a href="src_errors_errors.extendableerror.html#name" class="tsd-kind-icon">name</a>
372+
<a href="src_errors_extendable_error.extendableerror.html#name" class="tsd-kind-icon">name</a>
364373
</li>
365374
<li class=" tsd-kind-property tsd-parent-kind-class">
366-
<a href="src_errors_errors.extendableerror.html#preparestacktrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
375+
<a href="src_errors_extendable_error.extendableerror.html#preparestacktrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
367376
</li>
368377
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
369-
<a href="src_errors_errors.extendableerror.html#stack" class="tsd-kind-icon">stack</a>
378+
<a href="src_errors_extendable_error.extendableerror.html#stack" class="tsd-kind-icon">stack</a>
370379
</li>
371380
<li class=" tsd-kind-property tsd-parent-kind-class">
372-
<a href="src_errors_errors.extendableerror.html#stacktracelimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
381+
<a href="src_errors_extendable_error.extendableerror.html#stacktracelimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
373382
</li>
374383
<li class=" tsd-kind-property tsd-parent-kind-class">
375-
<a href="src_errors_errors.extendableerror.html#type" class="tsd-kind-icon">type</a>
384+
<a href="src_errors_extendable_error.extendableerror.html#type" class="tsd-kind-icon">type</a>
376385
</li>
377386
<li class=" tsd-kind-method tsd-parent-kind-class">
378-
<a href="src_errors_errors.extendableerror.html#capturestacktrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
387+
<a href="src_errors_extendable_error.extendableerror.html#capturestacktrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
379388
</li>
380389
</ul>
381390
</li>
382391
</ul>
383392
<ul class="after-current">
384-
<li class=" tsd-kind-class tsd-parent-kind-module">
385-
<a href="src_errors_errors.generalerror.html" class="tsd-kind-icon">General<wbr>Error</a>
386-
</li>
387-
<li class=" tsd-kind-class tsd-parent-kind-module">
388-
<a href="src_errors_errors.valueerror.html" class="tsd-kind-icon">Value<wbr>Error</a>
389-
</li>
390-
<li class=" tsd-kind-function tsd-parent-kind-module">
391-
<a href="../modules/src_errors_errors.html#valueerror-1" class="tsd-kind-icon">value<wbr>Error</a>
392-
</li>
393393
</ul>
394394
</nav>
395395
</div>

0 commit comments

Comments
 (0)