Skip to content

Commit 5eb2442

Browse files
Readme
1 parent 5ed62e2 commit 5eb2442

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Commit will be performed with default commit message, git user email and name.
103103
- default git user email: `[email protected]`
104104
- default git user name: `CleanupCode Action`
105105

106-
You can change commit message, git user email and name
106+
## Change commit message, git user email and name
107107

108108
```yaml
109109
steps:
@@ -116,7 +116,7 @@ steps:
116116
commit_creator_name: 'Knuth Conway'
117117
```
118118

119-
## Interrupt your CI/CD pipeline if clean up detected to be need
119+
## Interrupt your CI/CD pipeline if Cleanup detected the code needs to be cleaned up
120120

121121
```yaml
122122
steps:
@@ -127,8 +127,8 @@ steps:
127127
fail_on_reformat_needed: 'yes'
128128
```
129129

130-
This configuration causes the action to terminate and return an error code upon detection of the need for clean up code.
131-
This can be useful for interrupting the execution of further steps in the CI/CD pipeline.
130+
If this setting is enabled, the process will stop and return an error code if it finds that the code needs to be cleaned
131+
up. This can be helpful for stopping the pipeline from continuing if there are problems with the code.
132132

133133
## No interrupt and no clean up
134134

@@ -145,7 +145,7 @@ steps:
145145
At times, you may want to disable automatic clean up code and continue with the execution of your CI/CD pipeline, for
146146
instance, when you need to debug subsequent steps without performing clean up.
147147

148-
## Interrupt pipeline vs Clean up code
148+
## Interrupt the pipeline vs Clean up code
149149

150150
Note that if you set the action to automatically clean up code (which can be very helpful), you risk encountering the
151151
need to resolve conflicts later if you forget to pull the automatically-committed changes.
@@ -210,8 +210,20 @@ initiated
210210

211211
# Cleanup Code works perfectly with Inspect Code
212212

213-
**To see an example how this can be used and to learn more about it, please refer to the demo project:**
214-
**[GitHub Action of ReSharper CLI CleanupCode Demo](https://github.com/ArturWincenciak/ReSharper_CleanupCode_Demo/tree/demo_inspect_code#clean-up-code-works-perfectly-with-inspect-code)**
213+
There are situations where Cleanup Code does not do the entire job for us, but we can still greatly help ourselves and
214+
speed up ours Code Review process by adding an additional automatic step that performs an inspection of the code and,
215+
adds a comments to the submitted Pull Request on our behalf.
216+
217+
Here in that demo project
218+
[ReSharper CLI CleanupCode GitHub Action Demo](https://github.com/ArturWincenciak/ReSharper_CleanupCode_Demo#cleanup-code-works-perfectly-with-inspect-code),
219+
I show you how to combine [ReSharper CLI CleanupCode](https://github.com/marketplace/actions/resharper-cli-cleanupcode)
220+
and [ReSharper CLI InspectCode](https://github.com/marketplace/actions/resharper-cli-inspectcode)
221+
using [GitHub Action Definition](https://github.com/ArturWincenciak/ReSharper_CleanupCode_Demo/blob/main/.github/workflows/cleanup_code.yml)
222+
that contains two jobs: `cleanup` and `inspection`.
223+
224+
Refer to
225+
[the demo project](https://github.com/ArturWincenciak/ReSharper_CleanupCode_Demo#cleanup-code-works-perfectly-with-inspect-code)
226+
and gain all the knowledge on how to speed up your daily development process.
215227

216228
```yaml
217229
name: ReSharper CLI CleanupCode
@@ -272,6 +284,10 @@ jobs:
272284
minimumSeverity: notice
273285
solutionWideAnalysis: true
274286
```
275-
### Used actions:
276-
- **Marketplace: [ReSharper CLI CleanupCode](https://github.com/marketplace/actions/resharper-cli-cleanupcode)**
277-
- **Marketplace: [ReSharper CLI InspectCode](https://github.com/marketplace/actions/resharper-cli-inspectcode)**
287+
288+
> _[ReSharper CLI InspectCode](https://github.com/marketplace/actions/resharper-cli-inspectcode) - that one I've found
289+
> in the Marketplace and used in the
290+
> [demo project](https://github.com/ArturWincenciak/ReSharper_CleanupCode_Demo#cleanup-code-works-perfectly-with-inspect-code),
291+
> it was an **inspiration** for me to create my own `ReSharper CLI CleanupCode` the second tool in this toolkit. These two
292+
tools complement each other well and produce nice results._
293+

0 commit comments

Comments
 (0)