Skip to content

not much #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Regex on Repo
Or simply `ror` is a github action that does that.

This action works on: `ubuntu`, `windows` and `macos`
Or simply `ror` is a github action that does regex, on files on a cloud repository without doing a git checkout.

However running under `windows` takes 1 minute longer due the nature of the Windows Server operating system. (1 minute and 57 seconds)
[![Multiplatform Test](https://github.com/Tilation/regex-on-repo/actions/workflows/main.yml/badge.svg)](https://github.com/Tilation/regex-on-repo/actions/workflows/main.yml)


Runner OS | Notes
---|---
`ubuntu` | Working fine
`macos` | Working fine
`windows` | Takes 1 minute longer, still fine

### Example usage

Expand All @@ -18,15 +24,15 @@ jobs:
runs-on: ubuntu-latest

steps:
- name: Regex On Repo
- name: Multiplatform Regex
id: regex
uses: tilation/regex-on-repo@ver # replace ver with version number
uses: tilation/regex-on-repo
with:
github: 'tilation/regex-on-repo' # can use ${{ github.repository }}
ref: 'main' # can use ${{ github.ref }}
github: ${{ github.repository }}
ref: 'development'
token: ${{ secrets.GITHUB_TOKEN }}
regex: '`([^`\W]+)`'
file: 'README.MD'
file: 'README.md'
debug: true
```

Expand Down
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'Regex on Repo'
description: 'Runs regex on repositories, on the cloud!'
name: 'Multiplatform Regex'
description: 'Runs regex on repositories, without doing the lengthy checkout!'
branding:
icon: book
color: green
Expand Down Expand Up @@ -50,4 +50,4 @@ runs:
run: |
dotnet restore
dotnet build
dotnet run
dotnet run