Skip to content

Commit

Permalink
Merge pull request #412 from linear-b/fix-extract-typo
Browse files Browse the repository at this point in the history
fixed typo extract to extract in file names
  • Loading branch information
vim-zz authored Jan 8, 2024
2 parents 5e36204 + a0e3eb0 commit 41b52de
Show file tree
Hide file tree
Showing 15 changed files with 60 additions and 60 deletions.
6 changes: 3 additions & 3 deletions docs/filter-function-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ JavaScript plugins that enable custom filter functions for gitStream. To learn h

--8<-- "plugins/filters/compareSemver/README.md"

--8<-- "plugins/filters/extarctDependabotVersionBump/README.md"
--8<-- "plugins/filters/extractDependabotVersionBump/README.md"

--8<-- "plugins/filters/extarctSnykVersionBump/README.md"
--8<-- "plugins/filters/extractSnykVersionBump/README.md"

--8<-- "plugins/filters/extarctOrcaFindings/README.md"
--8<-- "plugins/filters/extractOrcaFindings/README.md"

--8<-- "plugins/filters/getCodeowners/README.md"

Expand Down
22 changes: 0 additions & 22 deletions plugins/filters/extarctDependabotVersionBump/README.md

This file was deleted.

22 changes: 0 additions & 22 deletions plugins/filters/extarctSnykVersionBump/README.md

This file was deleted.

22 changes: 22 additions & 0 deletions plugins/filters/extractDependabotVersionBump/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
--8<-- "plugins/filters/extractDependabotVersionBump/reference.md"

??? note "Plugin Code: extractDependabotVersionBump"
```javascript
--8<-- "plugins/filters/extractDependabotVersionBump/index.js"
```
<div class="result" markdown>
<span>
</span>
</div>


??? example "gitStream CM Example: extractDependabotVersionBump"
```yaml+jinja
--8<-- "plugins/filters/extractDependabotVersionBump/extract_dependabot_version_bump.cm"
```
<div class="result" markdown>
<span>
</span>
</div>

[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/extractDependabotVersionBump)
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ automations:
comment: |
Dependabot `patch` version bumps are approved and merged automatically.

bump: {{ pr.description | extarctDependabotVersionBump | compareSemver }}
bump: {{ pr.description | extractDependabotVersionBump | compareSemver }}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* @module extarctDependabotVersionBump
* @module extractDependabotVersionBump
* @description Extract version bump information from Dependabot PRs description
* @param {string} description - the PR description
* @returns {string[]} V1 (to) and V2 (from)
* @example {{ pr.description | extarctDependabotVersionBump | compareSemver }}
* @example {{ pr.description | extractDependabotVersionBump | compareSemver }}
* @license MIT
**/

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<a name="module_extarctDependabotVersionBump"></a>
<a name="module_extractDependabotVersionBump"></a>

## extarctDependabotVersionBump
## extractDependabotVersionBump
Extract version bump information from Dependabot PRs description

**Returns**: <code>Array.&lt;string&gt;</code> - V1 (to) and V2 (from)
Expand All @@ -12,5 +12,5 @@ Extract version bump information from Dependabot PRs description

**Example**
```js
{{ pr.description | extarctDependabotVersionBump | compareSemver }}
{{ pr.description | extractDependabotVersionBump | compareSemver }}
```
2 changes: 1 addition & 1 deletion plugins/filters/extractOrcaFindings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ It can be easily edited and adjusted as you like. For example, if you dont like

??? example "gitStream CM Example: extractOrcaFindings"
```yaml+jinja
--8<-- "plugins/filters/extractOrcaFindings/extarct_orca_findings.cm"
--8<-- "plugins/filters/extractOrcaFindings/extract_orca_findings.cm"
```
<div class="result" markdown>
<span>
Expand Down
22 changes: 22 additions & 0 deletions plugins/filters/extractSnykVersionBump/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
--8<-- "plugins/filters/extractSnykVersionBump/reference.md"

??? note "Plugin Code: extractSnykVersionBump"
```javascript
--8<-- "plugins/filters/extractSnykVersionBump/index.js"
```
<div class="result" markdown>
<span>
</span>
</div>


??? example "gitStream CM Example: extractSnykVersionBump"
```yaml+jinja
--8<-- "plugins/filters/extractSnykVersionBump/extract_snyk_version_bump.cm"
```
<div class="result" markdown>
<span>
</span>
</div>

[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/extractSnykVersionBump)
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ automations:
comment: |
Snyk `patch` version bumps are approved and merged automatically.

bump: {{ pr.description | extarctSnykVersionBump | compareSemver }}
bump: {{ pr.description | extractSnykVersionBump | compareSemver }}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* @module extarctSnykVersionBump
* @module extractSnykVersionBump
* @description Extract version bump information from Snyk PRs description
* @param {string} description - the PR description
* @returns {string[]} V1 (to) and V2 (from)
* @example {{ pr.description | extarctSnykVersionBump | compareSemver }}
* @example {{ pr.description | extractSnykVersionBump | compareSemver }}
* @license MIT
**/

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<a name="module_extarctSnykVersionBump"></a>
<a name="module_extractSnykVersionBump"></a>

## extarctSnykVersionBump
## extractSnykVersionBump
Extract version bump information from Snyk PRs description

**Returns**: <code>Array.&lt;string&gt;</code> - V1 (to) and V2 (from)
Expand All @@ -12,5 +12,5 @@ Extract version bump information from Snyk PRs description

**Example**
```js
{{ pr.description | extarctSnykVersionBump | compareSemver }}
{{ pr.description | extractSnykVersionBump | compareSemver }}
```

0 comments on commit 41b52de

Please sign in to comment.