Skip to content
This repository has been archived by the owner on Mar 4, 2021. It is now read-only.

Improve body/body_path documentation #91

Open
hmontone opened this issue Aug 29, 2020 · 2 comments
Open

Improve body/body_path documentation #91

hmontone opened this issue Aug 29, 2020 · 2 comments

Comments

@hmontone
Copy link

hmontone commented Aug 29, 2020

README.md:

body: Text describing the contents of the release. Optional, and not needed if using body_path.
body_path: A file with contents describing the release. Optional, and not needed if using body.

Of course body is not needed if using body_path and body_path is not needed if using body, since they are optional according to the documentation. What would be useful, however, is to know what happens when both or neither of them is defined.

@hmontone
Copy link
Author

hmontone commented Aug 29, 2020

How about something like:

`body`: Text describing the contents of the release. If `body_path` is given, its contents will take precedence. If neither `body` or `body_path` is given, the release will be created with an empty body.
`body_path`: A file with contents describing the release. See also `body`.

@tavrez
Copy link

tavrez commented Sep 1, 2020

Please also add how should we address the file for body_path, absolute or relative, and relative to where

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants