Skip to content

Commit

Permalink
Fix: README.md comments showing in GitHub portal
Browse files Browse the repository at this point in the history
Also, minor changes to interactive help on the script's CLI

Change-Id: I427b6b3e37b78285e1b20d337f1ab6b5b28ec329
Signed-off-by: Matthew Watkins <[email protected]>
  • Loading branch information
ModeSevenIndustrialSolutions committed May 30, 2024
1 parent 0532628 commit fd4e235
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Script to automate the upload of files to Nexus servers

[Source Code in Gerrit](https://gerrit.linuxfoundation.org/infra/admin/repos/releng/nexus-upload,general)
[Source Code on GitHub](https://github.com/lfit/releng-nexus-upload)
- [Source Code in Gerrit](https://gerrit.linuxfoundation.org/infra/admin/repos/releng/nexus-upload,general)
- [Source Code on GitHub](https://github.com/lfit/releng-nexus-upload)

## Getting started

Expand All @@ -17,12 +17,12 @@ Help is available directly from the command-line:

```console
./nexus-upload.sh -h
Usage: nexus-upload.sh [-h] [-u username] [-p password] [-s upload-url] [-e file extension] [-d folder]
Usage: nexus-upload.sh [-h] [-u user] [-p password] [-s upload-url] [-e extension] [-d folder]
-h display this help and exit
-u username (or export variable NEXUS_USERNAME)
-p password (or export variable NEXUS_PASSWORD)
-s upload URL (or export variable NEXUS_URL)
e.g. https://nexus3.o-ran-sc.org/repository/datasets/
e.g. https://nexus3.o-ran-sc.org/repository/datasets/
-e file extensions to match, e.g. csv, txt
-d local directory hosting files/content to be uploaded
```
Expand All @@ -39,5 +39,7 @@ specified, then the script itself may be matched by the default wildcard (\*) fi
prevent this, specify an extension restricting the files to be uploaded using the "-e" flag. Alternatively,
put the files into a local folder, and sepficy the folder location using the "-d" flag.

<!--
[comment]: # SPDX-License-Identifier: Apache-2.0
[comment]: # Copyright 2024 The Linux Foundation <[email protected]>
-->
2 changes: 1 addition & 1 deletion nexus-upload.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ SUCCESSES="0"; FAILURES="0"
show_help() {
# Command usage help
cat << EOF
Usage: ${0##*/} [-h] [-u username] [-p password] [-s upload-url] [-e match file extensions] [-d upload/content folder]
Usage: ${0##*/} [-h] [-u user] [-p password] [-s upload-url] [-e extensions] [-d folder]
-h display this help and exit
-u username (or export variable NEXUS_USERNAME)
-p password (or export variable NEXUS_PASSWORD)
Expand Down

0 comments on commit fd4e235

Please sign in to comment.