Skip to content

Archive repositories do not return draft releases #42019

@frankmalin

Description

@frankmalin

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#list-releases
https://docs.github.com/en/enterprise-cloud@latest/rest/releases/releases?apiVersion=2022-11-28#list-releases
https://docs.github.com/en/enterprise-server@3.19/rest/releases/releases?apiVersion=2022-11-28#list-releases

What changes are you suggesting?

Documentation States:

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

Requested Change:

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. Repositories in an archived state do not return draft releases.

API behavior:
The rest call will not return draft releases for archived repositories.

Issue:
When writing a comparison function to verify that repositories migrated from one org to another failed comparison to check the release artifacts, since one repository had been archived.

The documentation should support the behavior of the API.

Additional information

Steps to reproduce:

  • Migrate repository using gh gei from src to dst org
  • add step to migration process to pull published and draft releases to dst org
  • Archive repository in the src org
  • Run post migration step to ensure :
    • compare issues migrated
    • compare branch/sha
    • compare release artifacts
      The release artifacts compare fails, since the repository in the src org had been archived.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions