How to list packages and versions in github package registry? #24680

tombrus · 2019-11-21T19:14:57Z

tombrus
Nov 21, 2019

What is the best way to list github packages in a script?

Thanks,

Tom

Answered by tombrus

Jun 23, 2020

fronix:

updatedAt

I found the following on the GraphQL API v4 change log page:

reg your updatedAt:

On member RegistryPackageVersion.updatedAt: updatedAt will be removed. 
Use the PackageVersion object instead. Effective 2020-04-01.

and on my registryPackages:

On member Organization.registryPackages: registryPackages will be removed.
Use the PackageOwner object instead. Effective 2020-04-01.

So I guess we are using some moving targets 😦
On the other hand, improving APIs is also good! :slight_smile:

View full answer

tombrus · 2019-11-21T23:46:15Z

tombrus
Nov 21, 2019
Author

…after a little bit of hacking I came up with the following bash script, using GraphQL/curl/jq:

graphqlQuery() {
  local query="$1"; shift
curl -s -H "Authorization: bearer $INPUT_TOKEN" -X POST -d '{"query":"'"$query"'"}' 'https://api.github.com/graphql'

}

listPackageVersions() {

local g="$1"; shift

local a="$1"; shift
local query="$(cat <<EOF | sed 's/"/\"/g' | tr '\n\r' ' '

query {

repository(owner:"$USERNAME", name:"$REPOSNAME"){

registryPackages(name:"$g.$a",first:1) {

nodes {

versions(last:100) {

nodes {

version

}

}

}

}

}

}

EOF

)"

graphqlQuery "$query" | jq -r '.data.repository.registryPackages.nodes[0].versions.nodes[].version'

}

just thought I’d share it.

-Tom

0 replies

tombrus · 2020-06-22T20:52:46Z

tombrus
Jun 22, 2020
Author

Since the registryPackages seems to have been refactored to packages I had to change my script around. Again, just thought I’d share it… her is my new version:

graphqlQuery() {
  local query="$1"; shift
curl -s -H "Authorization: bearer $INPUT_TOKEN" -X POST -d '{"query":"'"$query"'"}' 'https://api.github.com/graphql'

}

listPackageVersions() {

local g="$1"; shift

local a="$1"; shift
local query="$(cat <<EOF | sed 's/"/\"/g' | tr '\n\r' ' '

query {

repository(owner:"$USERNAME", name:"$REPOSNAME"){

packages(names:"$g.$a",first:1) {

nodes {

versions(first:100) {

nodes {

version

}

}

}

}

}

}

EOF

)"

graphqlQuery "$query" | jq -r '.data.repository.packages.nodes[0].versions.nodes[].version'

}

0 replies

Fronix · 2020-06-23T08:43:42Z

Fronix
Jun 23, 2020

Apparantly they removed the updatedAt aswell which is what I was using… Not sure how to get that date now can’t find anything.

Following does not work:

query {
          repository(owner: "User", name: "repo") {
              packages(first:100){
                nodes {
                    name,
                    packageType 
                    versions(first:100) {
                        nodes {
                            id,
                            version,
                            updatedAt
                        }
                    }
                }
              }
          }
      }

0 replies

Fronix · 2020-06-23T10:04:37Z

Fronix
Jun 23, 2020

So it seems the only way to get a date that should be something close to the actual package date would be PackageFile object.

New query:

query {
          repository(owner: "User", name: "repo") {
              packages(first:100){
                nodes {
                    id
                    name
                    packageType 
                    versions(first:100) {
                        nodes {
                            id
                            version
                            files(first: 10) {
                                nodes {
                                    name
                                    updatedAt
                                }
                            }
                        }
                    }
                }
              }
          }
      }

0 replies

tombrus · 2020-06-23T11:37:46Z

tombrus
Jun 23, 2020
Author

fronix:

updatedAt

I found the following on the GraphQL API v4 change log page:

reg your updatedAt:

On member RegistryPackageVersion.updatedAt: updatedAt will be removed. 
Use the PackageVersion object instead. Effective 2020-04-01.

and on my registryPackages:

On member Organization.registryPackages: registryPackages will be removed.
Use the PackageOwner object instead. Effective 2020-04-01.

So I guess we are using some moving targets 😦
On the other hand, improving APIs is also good! :slight_smile:

0 replies

Fronix · 2020-06-24T13:28:11Z

Fronix
Jun 24, 2020

Yeah I found that as well, well seems like we’ll have to rewrite these things a few times before its out of beta 😛

0 replies

gihanrangana · 2021-01-24T18:23:21Z

gihanrangana
Jan 24, 2021

how can i run this on nodejs? i have no idea about GraphQl

0 replies

joshjohanning · 2021-11-30T20:01:36Z

joshjohanning
Nov 30, 2021

@SL-CodeBlaster - (late reply but for others who find this)

You can use the GitHub GraphQL Explorer: Explorer - GitHub Docs

Or you could use Postman:

write a POST to https://api.github.com/graphql
Add your GitHub PAT under the Authorization tab as a Bearer
In the Body, change to GraphQL and copy in the query here

image938×366 39.7 KB

image978×603 42.1 KB

0 replies

ubudragon · 2023-08-05T05:57:29Z

ubudragon
Aug 5, 2023

doesn't work anymore, pakageType npm deprecated and we must use GitHub rest API now

3 replies

joshjohanning Aug 5, 2023

packages=$(gh api --paginate "/orgs/${ORG}/packages?package_type=npm" -q '.[] | .name + " " + .repository.name')

echo "$packages" | while IFS= read -r response; do

  package_name=$(echo "$response" | cut -d ' ' -f 1)
  repo_name=$(echo "$response" | cut -d ' ' -f 2)

  echo "org: $ORG repo: $repo_name --> package name $package_name"
  
  versions=$(gh api --paginate "/orgs/${ORG}/packages/npm/${package_name}/versions" -q '.[] | .name' | sort -V)

  for version in $versions
  do
    echo "$version"
  done

https://docs.github.com/en/free-pro-team@latest/rest/packages/packages?apiVersion=2022-11-28#list-packages-for-an-organization

ubudragon Aug 6, 2023

thanks, joshjohanning!
but for our org, it returns only 30 packages instead of 150+ total
I tried to call the gh API with a different page: headers - all the same, only 30 packages in response (despite the response json has nearly 3000 lines)

joshjohanning Aug 6, 2023

ahh oops forgot pagination @ubudragon! Edited the above code snippet.

Need the gh api --paginate to retrieve multiple pages of results 😄

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

How to list packages and versions in github package registry? #24680

{{title}}

Replies: 9 comments 3 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

Select a reply

How to list packages and versions in github package registry? #24680

Replies: 9 comments · 3 replies

tombrus Nov 21, 2019 Author

tombrus Jun 22, 2020 Author

tombrus Jun 23, 2020 Author

Replies: 9 comments 3 replies

tombrus
Nov 21, 2019
Author

tombrus
Jun 22, 2020
Author

tombrus
Jun 23, 2020
Author