From a0e3eb001f3682abca2691c8fb2eb8e3af09b085 Mon Sep 17 00:00:00 2001 From: ofer affias Date: Mon, 8 Jan 2024 17:13:41 +0200 Subject: [PATCH] fixed typo extract to extract in file names --- docs/filter-function-plugins.md | 6 ++--- .../extarctDependabotVersionBump/README.md | 22 ------------------- .../filters/extarctSnykVersionBump/README.md | 22 ------------------- .../LICENSE | 0 .../extractDependabotVersionBump/README.md | 22 +++++++++++++++++++ .../extract_dependabot_version_bump.cm} | 2 +- .../index.js | 4 ++-- .../reference.md | 6 ++--- plugins/filters/extractOrcaFindings/README.md | 2 +- ...a_findings.cm => extract_orca_findings.cm} | 0 .../LICENSE | 0 .../filters/extractSnykVersionBump/README.md | 22 +++++++++++++++++++ .../extract_snyk_version_bump.cm} | 2 +- .../index.js | 4 ++-- .../reference.md | 6 ++--- 15 files changed, 60 insertions(+), 60 deletions(-) delete mode 100644 plugins/filters/extarctDependabotVersionBump/README.md delete mode 100644 plugins/filters/extarctSnykVersionBump/README.md rename plugins/filters/{extarctDependabotVersionBump => extractDependabotVersionBump}/LICENSE (100%) create mode 100644 plugins/filters/extractDependabotVersionBump/README.md rename plugins/filters/{extarctDependabotVersionBump/extarct_dependabot_version_bump.cm => extractDependabotVersionBump/extract_dependabot_version_bump.cm} (92%) rename plugins/filters/{extarctDependabotVersionBump => extractDependabotVersionBump}/index.js (86%) rename plugins/filters/{extarctDependabotVersionBump => extractDependabotVersionBump}/reference.md (67%) rename plugins/filters/extractOrcaFindings/{extarct_orca_findings.cm => extract_orca_findings.cm} (100%) rename plugins/filters/{extarctSnykVersionBump => extractSnykVersionBump}/LICENSE (100%) create mode 100644 plugins/filters/extractSnykVersionBump/README.md rename plugins/filters/{extarctSnykVersionBump/extarct_snyk_version_bump.cm => extractSnykVersionBump/extract_snyk_version_bump.cm} (92%) rename plugins/filters/{extarctSnykVersionBump => extractSnykVersionBump}/index.js (86%) rename plugins/filters/{extarctSnykVersionBump => extractSnykVersionBump}/reference.md (68%) diff --git a/docs/filter-function-plugins.md b/docs/filter-function-plugins.md index 49fa768c..caed507c 100644 --- a/docs/filter-function-plugins.md +++ b/docs/filter-function-plugins.md @@ -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" diff --git a/plugins/filters/extarctDependabotVersionBump/README.md b/plugins/filters/extarctDependabotVersionBump/README.md deleted file mode 100644 index 8acf122c..00000000 --- a/plugins/filters/extarctDependabotVersionBump/README.md +++ /dev/null @@ -1,22 +0,0 @@ ---8<-- "plugins/filters/extarctDependabotVersionBump/reference.md" - -??? note "Plugin Code: extarctDependabotVersionBump" - ```javascript - --8<-- "plugins/filters/extarctDependabotVersionBump/index.js" - ``` -
- - -
- - -??? example "gitStream CM Example: extarctDependabotVersionBump" - ```yaml+jinja - --8<-- "plugins/filters/extarctDependabotVersionBump/extarct_dependabot_version_bump.cm" - ``` -
- - -
- -[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/extarctDependabotVersionBump) diff --git a/plugins/filters/extarctSnykVersionBump/README.md b/plugins/filters/extarctSnykVersionBump/README.md deleted file mode 100644 index 2b3dceab..00000000 --- a/plugins/filters/extarctSnykVersionBump/README.md +++ /dev/null @@ -1,22 +0,0 @@ ---8<-- "plugins/filters/extarctSnykVersionBump/reference.md" - -??? note "Plugin Code: extarctSnykVersionBump" - ```javascript - --8<-- "plugins/filters/extarctSnykVersionBump/index.js" - ``` -
- - -
- - -??? example "gitStream CM Example: extarctSnykVersionBump" - ```yaml+jinja - --8<-- "plugins/filters/extarctSnykVersionBump/extarct_snyk_version_bump.cm" - ``` -
- - -
- -[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/extarctSnykVersionBump) diff --git a/plugins/filters/extarctDependabotVersionBump/LICENSE b/plugins/filters/extractDependabotVersionBump/LICENSE similarity index 100% rename from plugins/filters/extarctDependabotVersionBump/LICENSE rename to plugins/filters/extractDependabotVersionBump/LICENSE diff --git a/plugins/filters/extractDependabotVersionBump/README.md b/plugins/filters/extractDependabotVersionBump/README.md new file mode 100644 index 00000000..9b1eb7d0 --- /dev/null +++ b/plugins/filters/extractDependabotVersionBump/README.md @@ -0,0 +1,22 @@ +--8<-- "plugins/filters/extractDependabotVersionBump/reference.md" + +??? note "Plugin Code: extractDependabotVersionBump" + ```javascript + --8<-- "plugins/filters/extractDependabotVersionBump/index.js" + ``` +
+ + +
+ + +??? example "gitStream CM Example: extractDependabotVersionBump" + ```yaml+jinja + --8<-- "plugins/filters/extractDependabotVersionBump/extract_dependabot_version_bump.cm" + ``` +
+ + +
+ +[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/extractDependabotVersionBump) diff --git a/plugins/filters/extarctDependabotVersionBump/extarct_dependabot_version_bump.cm b/plugins/filters/extractDependabotVersionBump/extract_dependabot_version_bump.cm similarity index 92% rename from plugins/filters/extarctDependabotVersionBump/extarct_dependabot_version_bump.cm rename to plugins/filters/extractDependabotVersionBump/extract_dependabot_version_bump.cm index 171aee55..4565aaa6 100644 --- a/plugins/filters/extarctDependabotVersionBump/extarct_dependabot_version_bump.cm +++ b/plugins/filters/extractDependabotVersionBump/extract_dependabot_version_bump.cm @@ -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 }} diff --git a/plugins/filters/extarctDependabotVersionBump/index.js b/plugins/filters/extractDependabotVersionBump/index.js similarity index 86% rename from plugins/filters/extarctDependabotVersionBump/index.js rename to plugins/filters/extractDependabotVersionBump/index.js index 31b103c7..46652fe5 100644 --- a/plugins/filters/extarctDependabotVersionBump/index.js +++ b/plugins/filters/extractDependabotVersionBump/index.js @@ -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 **/ diff --git a/plugins/filters/extarctDependabotVersionBump/reference.md b/plugins/filters/extractDependabotVersionBump/reference.md similarity index 67% rename from plugins/filters/extarctDependabotVersionBump/reference.md rename to plugins/filters/extractDependabotVersionBump/reference.md index 5ef925e6..0a7921fe 100644 --- a/plugins/filters/extarctDependabotVersionBump/reference.md +++ b/plugins/filters/extractDependabotVersionBump/reference.md @@ -1,6 +1,6 @@ - + -## extarctDependabotVersionBump +## extractDependabotVersionBump Extract version bump information from Dependabot PRs description **Returns**: Array.<string> - V1 (to) and V2 (from) @@ -12,5 +12,5 @@ Extract version bump information from Dependabot PRs description **Example** ```js -{{ pr.description | extarctDependabotVersionBump | compareSemver }} +{{ pr.description | extractDependabotVersionBump | compareSemver }} ``` diff --git a/plugins/filters/extractOrcaFindings/README.md b/plugins/filters/extractOrcaFindings/README.md index 9291454a..8573f714 100644 --- a/plugins/filters/extractOrcaFindings/README.md +++ b/plugins/filters/extractOrcaFindings/README.md @@ -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" ```
diff --git a/plugins/filters/extractOrcaFindings/extarct_orca_findings.cm b/plugins/filters/extractOrcaFindings/extract_orca_findings.cm similarity index 100% rename from plugins/filters/extractOrcaFindings/extarct_orca_findings.cm rename to plugins/filters/extractOrcaFindings/extract_orca_findings.cm diff --git a/plugins/filters/extarctSnykVersionBump/LICENSE b/plugins/filters/extractSnykVersionBump/LICENSE similarity index 100% rename from plugins/filters/extarctSnykVersionBump/LICENSE rename to plugins/filters/extractSnykVersionBump/LICENSE diff --git a/plugins/filters/extractSnykVersionBump/README.md b/plugins/filters/extractSnykVersionBump/README.md new file mode 100644 index 00000000..be8f5087 --- /dev/null +++ b/plugins/filters/extractSnykVersionBump/README.md @@ -0,0 +1,22 @@ +--8<-- "plugins/filters/extractSnykVersionBump/reference.md" + +??? note "Plugin Code: extractSnykVersionBump" + ```javascript + --8<-- "plugins/filters/extractSnykVersionBump/index.js" + ``` +
+ + +
+ + +??? example "gitStream CM Example: extractSnykVersionBump" + ```yaml+jinja + --8<-- "plugins/filters/extractSnykVersionBump/extract_snyk_version_bump.cm" + ``` +
+ + +
+ +[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/extractSnykVersionBump) diff --git a/plugins/filters/extarctSnykVersionBump/extarct_snyk_version_bump.cm b/plugins/filters/extractSnykVersionBump/extract_snyk_version_bump.cm similarity index 92% rename from plugins/filters/extarctSnykVersionBump/extarct_snyk_version_bump.cm rename to plugins/filters/extractSnykVersionBump/extract_snyk_version_bump.cm index c79e4a35..1e8e3713 100644 --- a/plugins/filters/extarctSnykVersionBump/extarct_snyk_version_bump.cm +++ b/plugins/filters/extractSnykVersionBump/extract_snyk_version_bump.cm @@ -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 }} diff --git a/plugins/filters/extarctSnykVersionBump/index.js b/plugins/filters/extractSnykVersionBump/index.js similarity index 86% rename from plugins/filters/extarctSnykVersionBump/index.js rename to plugins/filters/extractSnykVersionBump/index.js index 8e2fc3f2..7643f20e 100644 --- a/plugins/filters/extarctSnykVersionBump/index.js +++ b/plugins/filters/extractSnykVersionBump/index.js @@ -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 **/ diff --git a/plugins/filters/extarctSnykVersionBump/reference.md b/plugins/filters/extractSnykVersionBump/reference.md similarity index 68% rename from plugins/filters/extarctSnykVersionBump/reference.md rename to plugins/filters/extractSnykVersionBump/reference.md index c6fbb664..0261c2a7 100644 --- a/plugins/filters/extarctSnykVersionBump/reference.md +++ b/plugins/filters/extractSnykVersionBump/reference.md @@ -1,6 +1,6 @@ - + -## extarctSnykVersionBump +## extractSnykVersionBump Extract version bump information from Snyk PRs description **Returns**: Array.<string> - V1 (to) and V2 (from) @@ -12,5 +12,5 @@ Extract version bump information from Snyk PRs description **Example** ```js -{{ pr.description | extarctSnykVersionBump | compareSemver }} +{{ pr.description | extractSnykVersionBump | compareSemver }} ```