chore: initial release

Author: shubham-stepsecurity

.github/workflows/actions_release.yml

@@ -0,0 +1,21 @@
+name: Release GitHub Actions
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag for the release"
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    permissions:
+      actions: read
+      id-token: write
+      contents: write
+    uses: step-security/reusable-workflows/.github/workflows/actions_release.yaml@v1
+    with:
+      tag: "${{ github.event.inputs.tag }}"

.github/workflows/main.yml

@@ -0,0 +1,27 @@
+on: [push]
+
+jobs:
+  find-and-replace-job:
+    runs-on: ubuntu-latest
+    name: 'Find and replace on a string'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Run find-and-replace to remove refs/heads/
+        uses: ./
+        id: findandreplace
+        with:
+          source: ${{ github.ref }}
+          find: 'refs/heads/'
+          replace: ''
+      - name: Get the above output
+        run: echo "The replaced value is ${{ steps.findandreplace.outputs.value }}"
+      - name: Run find-and-replace to remove slashes
+        uses: ./
+        id: findandreplace2
+        with:
+          source: ${{ steps.findandreplace.outputs.value }}
+          find: '/'
+          replace: '-'
+      - name: Get the final output
+        run: echo "The replaced value is ${{ steps.findandreplace2.outputs.value }}"

.gitignore

@@ -0,0 +1,117 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+.idea
+
+node_modules/

.nvmrc

@@ -0,0 +1 @@
+16

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 StepSecurity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1 +1,42 @@
-# actions-find-and-replace-string
+# Find and replace strings
+
+This action executes find-and-replace on a given string (hint: use `${{ github.ref }}` to get your branch name and apply this on it for use in another action). 
+
+## Inputs
+
+### `source`
+
+**Required** The source string to apply this action to
+
+### `find`
+
+**Required** The text you want to search for within the branch name (eg. `ref/heads/`)
+
+### `replace`
+
+**Required** The text you want to replace (eg. `head-`, ``, `root_`)
+
+### `replaceAll`
+
+**Optional** Should replace all occurrences? (only 'true' string will be interpreted positive)
+
+## Outputs
+
+### `value`
+
+The new value containing the found-and-replaced string.
+
+### Example usage
+
+```yaml
+uses: step-security/actions-find-and-replace-string@v5
+with:
+    source: ${{ github.ref }} # this translates to ref/heads/main on the main branch, but can be any arbitrary string 
+    find: 'ref/heads/'        # we want to remove ref/heads/ from source 
+    replace: ''               # and replace it with a blank string (ie. removing it)
+```
+
+This will output `main`.
+
+Check out `.github/workflows/main.yml` for more examples
+

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please report security vulnerabilities to [email protected]

action.yml

@@ -0,0 +1,24 @@
+name: 'Find-and-replace strings'
+description: 'Finds and replaces text on a string'
+branding:
+  color: purple
+  icon: copy
+inputs:
+  source:
+    description: 'The text you want to run this action on'
+    required: true
+  find:
+    description: 'The text you are looking for'
+    required: true
+  replace:
+    description: 'The text you want to replace with'
+    required: true
+  replaceAll:
+    description: 'Replace all occurrences?'
+    required: false
+outputs:
+  value:
+    description: 'The new value after find-and-replace has been run'
+runs:
+  using: 'node20'
+  main: 'dist/index.js'