Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Update docs to test test.yaml triggers #21

Merged
merged 1 commit into from
Jun 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sonatype Nexus File Upload

Automate the upload of files to Sonatype Nexus servers in GitHub
Automates the upload of files/artefacts from GitHub Actions to Sonatype Nexus servers

- [Source Code on GitHub](https://github.com/ModeSevenIndustrialSolutions/nexus-upload-action)

Expand All @@ -24,26 +24,26 @@ machine [nexus-server]
password [nexus-password]
```

*NOTE: respect the indentation of the second and third lines in the example above*
NOTE: respect the indentation of the second and third lines in the example above

A local folder containing the files to upload is mandatory. If no file extensions are specified,
then the default behaviour is wildcard (\*) file matching. You can prevent this, by specifying
a file suffix/extension restricting the files to be uploaded to a subset of the folder content.

### Action Inputs/Outputs

**Mandatory Inputs**
#### Mandatory Inputs

- nexus_username
- nexus_password
- nexus_server
- nexus_repository
- upload_directory

**Optional Inputs**
#### Optional Inputs

- filename_suffix
- testing
- testing [true|false]

When testing is set to "true" an upload directory and sample text file (with a date/time stamp)
will automatically be created. This prevents the need to create test data or add files directly
Expand All @@ -54,7 +54,7 @@ to your repository when testing the action.
- repository_format
-->

**Outputs**
#### Outputs

- errors [ true | false ]
- successes [ numeric value ]
Expand Down