|
| 1 | +--- |
| 2 | +Order: 100 |
| 3 | +Title: Label |
| 4 | +--- |
| 5 | + |
| 6 | +When first setting up a repository, it is nice to be able to configure a set of |
| 7 | +default labels, so that you can have some consistency across your various |
| 8 | +projects. While GitHub, and other Source Control systems provide a set of |
| 9 | +default labels, they are not always exactly what you want. This command will |
| 10 | +remove all the current labels configured within a repository, and create a new |
| 11 | +set of them. |
| 12 | + |
| 13 | +:::{.alert .alert-info} |
| 14 | +**NOTE:** |
| 15 | + |
| 16 | +The available list of labels that are created is currently hard-coded into |
| 17 | +GitReleaseManager, it is not possible to configure them. This will come in a |
| 18 | +later version. |
| 19 | +::: |
| 20 | + |
| 21 | +## **Required Parameters** |
| 22 | + |
| 23 | +- `-u, --username`: The username to access GitHub with. This can't be used when |
| 24 | + using the token parameter. |
| 25 | +- `-p, --password`: The password to access GitHub with. This can't be used when |
| 26 | + using the token parameter. |
| 27 | +- `--token`: The access token to access GitHub with. This can't be used when |
| 28 | + using the username and password parameters. |
| 29 | +- `-o, --owner`: The owner of the repository. |
| 30 | +- `-r, --repository`: The name of the repository. |
| 31 | + |
| 32 | +## **Optional Parameters** |
| 33 | + |
| 34 | +- `-d, -targetDirectory`: The directory on which GitReleaseManager should be |
| 35 | + executed. Defaults to current directory. |
| 36 | +- `-l, -logFilePath`: Path to where log file should be created. Defaults to |
| 37 | + logging to console. |
| 38 | + |
| 39 | +## **Notes** |
| 40 | + |
| 41 | +For Authentication use either username and password, or token parameter |
| 42 | + |
| 43 | +## **Examples** |
| 44 | + |
| 45 | +```bash |
| 46 | +gitreleasemanager.exe label -u bob -p password -o repoOwner -r repo |
| 47 | + |
| 48 | +gitreleasemanager.exe label --username bob --password password --owner repoOwner --repository repo |
| 49 | + |
| 50 | +gitreleasemanager.exe label --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo |
| 51 | +``` |
0 commit comments