(docs) Document deprecation of Username and Password

Author: AdmiringWorm

docs/input/docs/commands/_auth-notes.md

@@ -0,0 +1,5 @@
+For Authentication it is recommended to use the token parameter.
+Authentication with a Username and Password have been deprecated, and
+will be removed in a future release of GitReleaseManager.
+This authentication method have also been deprecated officially at
+GitHub.com

docs/input/docs/commands/_deprecated-args.md

@@ -0,0 +1,9 @@
+## Deprecated Parameters
+
+The following parameters have been deprecated and should not be used in new
+code. This will be removed in a future release.
+
+- `-u, --username`: The username to access Version Control System with.
+  This can't be used when using the token parameter.
+- `-p, --password`: The password to access Version Control System with.
+  This can't be used when using the token parameter.

docs/input/docs/commands/add-assets.md

@@ -8,10 +8,6 @@ additional assets to the release using the addasset command.
 
 ## **Required Parameters**
 
-- `-u, --username`: The username to access GitHub with. This can't be used when
-    using the token parameter.
-- `-p, --password`: The password to access GitHub with. This can't be used when
-    using the token parameter.
 - `--token`: The access token to access GitHub with. This can't be used when
     using the username and password parameters.
 - `-o, --owner`: The owner of the repository.
@@ -28,16 +24,18 @@ additional assets to the release using the addasset command.
 - `-l, -logFilePath`: Path to where log file should be created. Defaults to
     logging to console.
 
+<?! Include "_deprecated-args.md /?>
+
 ## **Notes**
 
-For Authentication use either username and password, or token parameter
+<?! Include "_auth-notes.md" /?>
 
 ## **Examples**
 
 ```bash
-gitreleasemanager.exe addasset -t 0.1.0 -u bob -p password -o repoOwner -r repo -a c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
-
-gitreleasemanager.exe create --tagName 0.1.0 --username bob --password password --owner repoOwner --repository repo --assets c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
+gitreleasemanager.exe addasset -t 0.1.0 -u bob --token fsdfsf67657sdf5s7d5f -r repo -a c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
 
 gitreleasemanager.exe create --tagName 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo --assets c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
+
+gitreleasemanager.exe create --tagName 0.1.0 --username bob --password password --owner repoOwner --repository repo --assets c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
 ```

docs/input/docs/commands/close.md

@@ -9,10 +9,6 @@ milestone.
 
 ## **Required Parameters**
 
-- `-u, --username`: The username to access GitHub with. This can't be used when
-    using the token parameter.
-- `-p, --password`: The password to access GitHub with. This can't be used when
-    using the token parameter.
 - `--token`: The access token to access GitHub with. This can't be used when
     using the username and password parameters.
 - `-o, --owner`: The owner of the repository.
@@ -26,16 +22,18 @@ milestone.
 - `-l, --logFilePath`: Path to where log file should be created. Defaults to
     logging to console.
 
+<?! Include "_deprecated-args.md /?>
+
 ## **Notes**
 
-For Authentication use either username and password, or token parameter
+<?! Include "_auth-notes.md" /?>
 
 ## **Examples**
 
 ```bash
-gitreleasemanager.exe close -m 0.1.0 -u bob -p password -o repoOwner -r repo
-
-gitreleasemanager.exe close --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
+gitreleasemanager.exe close -m 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
 
 gitreleasemanager.exe close --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
+
+gitreleasemanager.exe close --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
 ```

docs/input/docs/commands/create.md

@@ -13,10 +13,6 @@ to include in the Release.
 
 ## **Required Parameters**
 
-- `-u, --username`: The username to access GitHub with. This can't be used when
-    using the token parameter.
-- `-p, --password`: The password to access GitHub with. This can't be used when
-    using the token parameter.
 - `--token`: The access token to access GitHub with. This can't be used when
     using the username and password parameters.
 - `-o, --owner`: The owner of the repository.
@@ -39,29 +35,31 @@ to include in the Release.
 - `-l, --logFilePath`: Path to where log file should be created. Defaults to
     logging to console.
 
+<?! Include "_deprecated-args.md /?>
+
 ## **Notes**
 
-For Authentication use either username and password, or token parameter
+<?! Include "_auth-notes.md" /?>
 
 ## **Examples**
 
 Use GitReleaseManager to create a Release, generating the release notes based on
 Milestone:
 
 ```bash
-gitreleasemanager.exe create -m 0.1.0 -u bob -p password -o repoOwner -r repo
-
-gitreleasemanager.exe create --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
+gitreleasemanager.exe create -m 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
 
 gitreleasemanager.exe create --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
+
+gitreleasemanager.exe create --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
 ```
 
 Use GitReleaseManager to create a Release, taking the release notes as an input parameter:
 
 ```bash
-gitreleasemanager.exe create -i c:\temp\releasenotes.md -n 0.1.0 -u bob -p password -o repoOwner -r repo
-
-gitreleasemanager.exe create --inputFilePath c:\temp\releasenotes.md --name 0.1.0 --username bob --password password --owner repoOwner --repository repo
+gitreleasemanager.exe create -i c:\temp\releasenotes.md -n 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
 
 gitreleasemanager.exe create --inputFilePath c:\temp\releasenotes.md --name 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
+
+gitreleasemanager.exe create --inputFilePath c:\temp\releasenotes.md --name 0.1.0 --username bob --password password --owner repoOwner --repository repo
 ```

docs/input/docs/commands/discard.md

@@ -15,10 +15,6 @@ delete a published release.
 
 ## **Required Parameters**
 
-- `-u, --username`: The username to access GitHub with. This can't be used when
-    using the token parameter.
-- `-p, --password`: The password to access GitHub with. This can't be used when
-    using the token parameter.
 - `--token`: The access token to access GitHub with. This can't be used when
     using the username and password parameters.
 - `-o, --owner`: The owner of the repository.
@@ -33,16 +29,18 @@ delete a published release.
 - `-l, -logFilePath`: Path to where log file should be created. Defaults to
     logging to console.
 
+<?! Include "_deprecated-args.md /?>
+
 ## **Notes**
 
-For Authentication use either username and password, or token parameter
+<?! Include "_auth-notes.md" /?>
 
 ## **Examples**
 
 ```bash
-gitreleasemanager.exe discard -m 0.1.0 -u bob -p password -o repoOwner -r repo
-
-gitreleasemanager.exe discard --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
+gitreleasemanager.exe discard -m 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
 
 gitreleasemanager.exe discard --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
+
+gitreleasemanager.exe discard --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
 ```

docs/input/docs/commands/export.md

@@ -13,10 +13,6 @@ using the tagName parameter.
 
 ## **Required Parameters**
 
-- `-u, --username`: The username to access GitHub with. This can't be used when
-    using the token parameter.
-- `-p, --password`: The password to access GitHub with. This can't be used when
-    using the token parameter.
 - `--token`: The access token to access GitHub with. This can't be used when
     using the username and password parameters.
 - `-o, --owner`: The owner of the repository.
@@ -32,18 +28,20 @@ using the tagName parameter.
 - `-l, --logFilePath`: Path to where log file should be created. Defaults to
     logging to console.
 
+<?! Include "_deprecated-args.md /?>
+
 ## **Notes**
 
-For Authentication use either username and password, or token parameter
+<?! Include "_auth-notes.md" /?>
 
 ## **Examples**
 
 Use GitReleaseManager to export all Release Notes:
 
 ```bash
-gitreleasemanager.exe export -u bob -p password -o repoOwner -r repo -f c:\temp\releases.md
-
-gitreleasemanager.exe export --username bob --password password --owner repoOwner --repository repo --fileOutputPath c:\temp\releases.md
+gitreleasemanager.exe export --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo -f c:\temp\releases.md
 
 gitreleasemanager.exe export --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo --fileOutputPath c:\temp\releases.md
+
+gitreleasemanager.exe export --username bob --password password --owner repoOwner --repository repo --fileOutputPath c:\temp\releases.md
 ```

docs/input/docs/commands/label.md

@@ -20,10 +20,6 @@ later version.
 
 ## **Required Parameters**
 
-- `-u, --username`: The username to access GitHub with. This can't be used when
-    using the token parameter.
-- `-p, --password`: The password to access GitHub with. This can't be used when
-    using the token parameter.
 - `--token`: The access token to access GitHub with. This can't be used when
     using the username and password parameters.
 - `-o, --owner`: The owner of the repository.
@@ -36,16 +32,18 @@ later version.
 - `-l, -logFilePath`: Path to where log file should be created. Defaults to
     logging to console.
 
+<?! Include "_deprecated-args.md /?>
+
 ## **Notes**
 
-For Authentication use either username and password, or token parameter
+<?! Include "_auth-notes.md" /?>
 
 ## **Examples**
 
 ```bash
-gitreleasemanager.exe label -u bob -p password -o repoOwner -r repo
-
-gitreleasemanager.exe label --username bob --password password --owner repoOwner --repository repo
+gitreleasemanager.exe label --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
 
 gitreleasemanager.exe label --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
+
+gitreleasemanager.exe label --username bob --password password --owner repoOwner --repository repo
 ```

docs/input/docs/commands/open.md

@@ -18,10 +18,6 @@ will be taken against a milestone that is already open.
 
 ## **Required Parameters**
 
-- `-u, --username`: The username to access GitHub with. This can't be used when
-    using the token parameter.
-- `-p, --password`: The password to access GitHub with. This can't be used when
-    using the token parameter.
 - `--token`: The access token to access GitHub with. This can't be used when
     using the username and password parameters.
 - `-o, --owner`: The owner of the repository.
@@ -35,16 +31,18 @@ will be taken against a milestone that is already open.
 - `-l, --logFilePath`: Path to where log file should be created. Defaults to
     logging to console.
 
+<?! Include "_deprecated-args.md /?>
+
 ## **Notes**
 
-For Authentication use either username and password, or token parameter
+<?! Include "_auth-notes.md" /?>
 
 ## **Examples**
 
 ```bash
-gitreleasemanager.exe open -m 0.1.0 -u bob -p password -o repoOwner -r repo
-
-gitreleasemanager.exe open --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
+gitreleasemanager.exe open -m 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
 
 gitreleasemanager.exe open --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
+
+gitreleasemanager.exe open --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
 ```

docs/input/docs/commands/publish.md

@@ -11,10 +11,6 @@ to actually publish a release.
 
 ## **Required Parameters**
 
-- `-u, --username`: The username to access GitHub with. This can't be used when
-    using the token parameter.
-- `-p, --password`: The password to access GitHub with. This can't be used when
-    using the token parameter.
 - `--token`: The access token to access GitHub with. This can't be used when
     using the username and password parameters.
 - `-o, --owner`: The owner of the repository.
@@ -29,16 +25,18 @@ to actually publish a release.
 - `-l, -logFilePath`: Path to where log file should be created. Defaults to
     logging to console.
 
+<?! Include "_deprecated-args.md /?>
+
 ## **Notes**
 
-For Authentication use either username and password, or token parameter
+<?! Include "_auth-notes.md" /?>
 
 ## **Examples**
 
 ```bash
-gitreleasemanager.exe publish -t 0.1.0 -u bob -p password -o repoOwner -r repo
-
-gitreleasemanager.exe publish --tagName 0.1.0 --username bob --password password --owner repoOwner --repository repo
+gitreleasemanager.exe publish -t 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
 
 gitreleasemanager.exe publish --tagName 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
+
+gitreleasemanager.exe publish --tagName 0.1.0 --username bob --password password --owner repoOwner --repository repo
 ```