Skip to content

Commit dbe060b

Browse files
committed
Changed name of the config-file cli parameter to just be config
1 parent 303b592 commit dbe060b

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ There are 2 ways to run this. As a .NET Tool installed on your machine, or downl
2121
- Install the tool globally by running `dotnet tool install --global ProgrammerAL.Tools.CodeUpdater --version 1.0.0`
2222
- Or clone this repository locally
2323
2. Run the application
24-
- If you installed the tool, run it with the command: `code-updater --config-file "C:/my-repos/my-app-1"`
25-
- If you downloaded the code, open a terminal to the `~/src/CodeUpdater/CodeUpdater` directory and run the application using dotnet run while passing in the required arguments. Example: `dotnet run -- --config-file "C:/my-repos/my-app-1"`
24+
- If you installed the tool, run it with the command: `code-updater --config "C:/my-repos/my-app-1"`
25+
- If you downloaded the code, open a terminal to the `~/src/CodeUpdater/CodeUpdater` directory and run the application using dotnet run while passing in the required arguments. Example: `dotnet run -- --config "C:/my-repos/my-app-1"`
2626
3. Wait for the application to finish. It will output the number of projects updated, and the number of projects that failed to update.
2727
4. Manually check a diff of all the file changes to ensure everything is as you expect
2828
5. Commit the code changes to source control. Wait for a CI/CD pipeline to run and ensure everything is still working as expected.
2929

3030
## CLI Options
3131

32-
- `-d|--config-file`
32+
- `-d|--config`
3333
- Required
3434
- Path to the file to use for config values when updating code
3535
- `-h|--help`

src/CodeUpdater/CodeUpdater/Options/CommandOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@
1111
namespace ProgrammerAL.Tools.CodeUpdater.Options;
1212
public class CommandOptions
1313
{
14-
[Option(shortName: 'c', longName: "config-file", Required = true, HelpText = "Path to the file to use for config values when updating code")]
14+
[Option(shortName: 'c', longName: "config", Required = true, HelpText = "Path to the file to use for config values when updating code")]
1515
public required string ConfigFile { get; set; }
1616
}

src/CodeUpdater/CodeUpdater/Program.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-

2-
using System;
1+
using System;
32
using System.Collections.Immutable;
43
using System.ComponentModel.DataAnnotations;
54
using System.Text;

0 commit comments

Comments
 (0)