Skip to content

Commit

Permalink
docs: update links to Github docs (#268)
Browse files Browse the repository at this point in the history
  • Loading branch information
browniebroke committed Oct 13, 2020
1 parent 540d153 commit c53162e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions semantic_release/hvcs.py
Expand Up @@ -86,6 +86,8 @@ def token() -> Optional[str]:
def check_build_status(owner: str, repo: str, ref: str) -> bool:
"""Check build status
https://docs.github.com/rest/reference/repos#get-the-combined-status-for-a-specific-reference
:param owner: The owner namespace of the repository
:param repo: The repository name
:param ref: The sha1 hash of the commit ref
Expand All @@ -103,7 +105,7 @@ def check_build_status(owner: str, repo: str, ref: str) -> bool:
def create_release(cls, owner: str, repo: str, tag: str, changelog: str) -> bool:
"""Create a new release
https://developer.github.com/v3/repos/releases/#create-a-release
https://docs.github.com/rest/reference/repos#create-a-release
:param owner: The owner namespace of the repository
:param repo: The repository name
Expand Down Expand Up @@ -132,7 +134,7 @@ def create_release(cls, owner: str, repo: str, tag: str, changelog: str) -> bool
def get_release(cls, owner: str, repo: str, tag: str) -> int:
"""Get a release by its tag name
https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name
https://docs.github.com/rest/reference/repos#get-a-release-by-tag-name
:param owner: The owner namespace of the repository
:param repo: The repository name
Expand All @@ -153,7 +155,7 @@ def get_release(cls, owner: str, repo: str, tag: str) -> int:
def edit_release(cls, owner: str, repo: str, id: int, changelog: str) -> bool:
"""Edit a release with updated change notes
https://developer.github.com/v3/repos/releases/#edit-a-release
https://docs.github.com/rest/reference/repos#update-a-release
:param owner: The owner namespace of the repository
:param repo: The repository name
Expand Down Expand Up @@ -204,7 +206,7 @@ def upload_asset(
) -> bool:
"""Upload an asset to an existing release
https://developer.github.com/v3/repos/releases/#upload-a-release-asset
https://docs.github.com/rest/reference/repos#upload-a-release-asset
:param owner: The owner namespace of the repository
:param repo: The repository name
Expand Down

0 comments on commit c53162e

Please sign in to comment.