Skip to content
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

Update README.md #148

Merged
merged 1 commit into from
Feb 16, 2024
Merged
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
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,31 @@
## Commands

That's what I can do :neckbeard::

- `@gstraccini help`: Shows the help message with available commands.
- `@gstraccini hello`: Says hello to the invoker.
- `@gstraccini thank you`: Replies with you are welcome message to the invoker.
- `@gstraccini bump version <version> <project>`: Bumps the .NET version in .csproj files.
- `version`: `[required]` The .NET version
- `project`: `[optional]` The .csproj file to update. Suppressing this parameter will run the command in all .csproj in the repository/branch
- `@gstraccini change runner <runner> <workflow> <jobs>`: Changes the GitHub action runner in a workflow file (.yml)
- `runner`: `[required]` The runner's name
- `workflow`: `[required]` The workflow filename (with or without the .yml/.yaml extension)
- `jobs`: `[optional]` The job's to apply this command. Suppressing this parameter will run the command in all jobs within the workflow
- `@gstraccini csharpier`: Formats the C# code using CSharpier (only for **.NET** projects).
- `@gstraccini fix csproj`: Fixes the csproj file with packages.config version of NuGet packages (only for **.NET Framework** projects).
- `@gstraccini review`: Enable review for the target pull request. This is useful when the PR submitter wasn't on the watch list before, the webhook was not captured, or some failed scenario occurred.
- `@gstraccini track`: Tracks the specified pull request. Queue a build, raise **[dependabot](https://github.com/dependabot), recreate** comment to resolve conflicts, and synchronize merge branches.
- `@gstraccini appveyor <type>`: Runs the [AppVeyor](https://ci.appveyor.com) build for the target commit and/or pull request.

Check notice on line 25 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L25

Expected: 80; Actual: 126
- `type`: `[required]` Specifies if should trigger a build in a `commit` or `pull request`.

Check notice on line 26 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L26

Column: 1

Check notice on line 26 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L26

Expected: 2; Actual: 1
- `@gstraccini bump version <version> <project>`: Bumps the [.NET version](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core) in .csproj files. :warning: (in development - maybe not working as expected!)

Check notice on line 27 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L27

Expected: 80; Actual: 224
- `version`: `[required]` The .NET version

Check notice on line 28 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L28

Column: 1

Check notice on line 28 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L28

Expected: 2; Actual: 1
- `project`: `[optional]` The `.csproj` file to update. Suppressing this parameter will run the command in all `.csproj` in the repository/branch.

Check notice on line 29 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L29

Column: 1

Check notice on line 29 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L29

Expected: 2; Actual: 1
- `@gstraccini change runner <runner> <workflow> <jobs>`: Changes the [GitHub action runner](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources) in a workflow file (.yml). :warning: (in development - maybe not working as expected!)

Check notice on line 30 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L30

Expected: 80; Actual: 340
- `runner`: `[required]` The runner's name

Check notice on line 31 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L31

Column: 1

Check notice on line 31 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L31

Expected: 2; Actual: 1
- `workflow`: `[required]` The workflow filename (with or without the .yml/.yaml extension).

Check notice on line 32 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L32

Column: 1

Check notice on line 32 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L32

Expected: 2; Actual: 1
- `jobs`: `[optional]` The jobs to apply this command. Suppressing this parameter will run the command in all jobs within the workflow.

Check notice on line 33 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L33

Column: 1

Check notice on line 33 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L33

Expected: 2; Actual: 1
- `@gstraccini csharpier`: Formats the C# code using [CSharpier](https://csharpier.com) (only for **.NET** projects).
- `@gstraccini fix csproj`: Updates the `.csproj` file with `packages.config` version of [NuGet packages](https://nuget.org) (only for **.NET Framework** projects). :warning: (in development - maybe not working as expected!)
- `@gstraccini prettier`: Formats the code using [Prettier](https://prettier.io).
- `@gstraccini review`: Enable review for the target pull request. This is useful when the PR submitter wasn't on the watch list, the webhook was not captured, or some failed scenario occurred.

Check notice on line 37 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L37

Expected: 80; Actual: 193
- `@gstraccini track`: Tracks the specified pull request. Queue a build, raise a **[dependabot](https://github.com/dependabot) recreate** comment to resolve conflicts, and synchronize merge branches. :warning: (in development - maybe not working as expected!)

Check notice on line 38 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L38

Expected: 80; Actual: 259
- `@gstraccini update snapshot`: Updaet tests snapshots (npm test -- -u) (only for **Node.js** projects).

Check notice on line 39 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L39

Expected: 80; Actual: 105


Multiple commands can be issued at the same time. Just respect each command pattern (with bot name prefix + command).

> **Warning**
>
>

Check notice on line 45 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L45

Expected: 0 or 2; Actual: 1
> If you aren't allowed to use this bot, a reaction with a thumbs down will be added to your comment.
> The allowed invokers are configurable via the `config.json` file.

---

Expand Down
Loading