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.

Sign up for GitHub

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

Update Maven deploy docs #20691

Merged
merged 2 commits into from
Aug 7, 2022
Merged

Update Maven deploy docs #20691

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0eaebad
Update deploy docs.
KN4CK3R Aug 6, 2022
08d9a82
Merge branch 'main' into docs-maven-deploy-file
lunny Aug 7, 2022
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
10 changes: 10 additions & 0 deletions docs/content/doc/packages/maven.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,16 @@ To publish a package simply run:
mvn deploy
```

If you want to publish a prebuild package to the registry, you can use [`mvn deploy:deploy-file`](https://maven.apache.org/plugins/maven-deploy-plugin/deploy-file-mojo.html):

```shell
mvn deploy:deploy-file -Durl=https://gitea.example.com/api/packages/{owner}/maven -DrepositoryId=gitea -Dfile=/path/to/package.jar
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mvn deploy:deploy-file -Durl=https://gitea.example.com/api/packages/{owner}/maven -DrepositoryId=gitea -Dfile=/path/to/package.jar
mvn deploy:deploy-file -Durl=$GITEA_URL/api/packages/$OWNER/maven -DrepositoryId=gitea -Dfile=$PATH_TO_PACKAGE.jar

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the parameters get changed here we need to change them in all package docs.

I have no real preference how it should look like.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Me neither, I simply thought that would be more fitting given that you use it in a fenced shell block, and hence the variables would be highlighted correctly.
However, I'd still add the URL and the PACKAGE_LOCATION as variables, because you have to look at the command right now to see that those need to be replaced as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not all code blocks are shell blocks but I may add another PR which changes the URLs for a placeholder.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ps: there are a lot of "example.com" in docs, so maybe there should be some guideline about how to write documents with example URLs.

```

| Parameter | Description |
| -------------- | ----------- |
| `owner` | The owner of the package. |
Comment on lines +90 to +92
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Parameter | Description |
| -------------- | ----------- |
| `owner` | The owner of the package. |
| Parameter | Description |
| -------------- | ----------- |
| `GITEA_URL` | The URL of the Gitea instance (i.e. `https://gitea.example.com`)|
| `OWNER` | The owner of the package. |
| `PATH_TO_PACKAGE` | The path where the jar is located |


You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.

## Install a package
Expand Down