Issue with getTree function

Aperta
#501 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
42/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
github, javascript, typescript
Ambito
api, devops

Direzione di ricerca

Start with the github.rest.git.getTree call shown in the workflow and trace how its parameters become the request URL. Compare that generated URL with the documented get-a-tree endpoint and the working curl example. Done means the cause of the 404 is documented or corrected, with a test covering the resulting request if this repository owns that behavior.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Describe the bug
I'm consistently receiving 404 errors when calling the github.rest.git.getTree API. From my testing it appears the URL parameter ?tree= is causing the issue, as if the API does not support this.

To Reproduce
my GithHub action is configured as:

      - name: Commit Changes
        id: commit-changes
        uses: actions/github-script@v7
        env:
          BRANCH: ${{ inputs.branch }}
        with:
          retries: 3
          github-token: ${{ steps.app-token.outputs.token }}
          script: |
              const tree = await github.rest.git.getTree({
                owner: context.repo.owner,
                repo: context.repo.repo,
                tree: process.env.BRANCH,
              })

where inputs.branch is set to main, and the 404 response is:

RequestError [HttpError]: Not Found
    at /home/runner/work/_actions/actions/github-script/v7/dist/index.js:9537:21
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async requestWithGraphqlErrorHandling (/home/runner/work/_actions/actions/github-script/v7/dist/index.js:9276:20)
    at async Job.doExecute (/home/runner/work/_actions/actions/github-script/v7/dist/index.js:10275:18) {
  status: 404,
  response: {
    url: 'https://api.github.com/repos/<my_org>/<my_repo>/git/trees/?tree=main',
    status: 404,
    headers: {
    ....
  },
  data: {
      message: 'Not Found',
      documentation_url: 'https://docs.github.com/rest/git/trees#get-a-tree',
      status: '404'
    }

When I test locally with Curl, this is what I see:

export TREE="https://api.github.com/repos/$OWNER/$REPO/git/trees/main"

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  "$TREE"

and the output is:

{
  "sha": "ff70bc62cd0fb0a01bd14a2b332b6b106b32ae38",
  "url": "https://api.github.com/repos/<my_org>/<my_repo>/git/trees/ff70bc62cd0fb0a01bd14a2b332b6b106b32ae38",
  "tree": [
    {
      "path": ".github",
      "mode": "040000",
      "type": "tree",
      "sha": "795e917b75291b5c0fa3fa219401bce1801420b5",
      "url": "https://api.github.com/repos/<my_org>/<my_repo>/git/trees/795e917b75291b5c0fa3fa219401bce1801420b5"
    },
    ...

When I run the same test, but include the ?tree= parameter, I get the same 404 error:

export TREE="https://api.github.com/repos/$OWNER/$REPO/git/trees/?tree=main"
curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  "$TREE

and the output is:

{
  "message": "Not Found",
  "documentation_url": "https://docs.github.com/rest/git/trees#get-a-tree",
  "status": "404"
}

Expected behavior
I expect a tree object to be returned.

Screenshots

RequestError [HttpError]: Not Found
    at /home/runner/work/_actions/actions/github-script/v7/dist/index.js:9537:21
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async requestWithGraphqlErrorHandling (/home/runner/work/_actions/actions/github-script/v7/dist/index.js:9276:20)
    at async Job.doExecute (/home/runner/work/_actions/actions/github-script/v7/dist/index.js:10275:18) {
  status: 404,
  response: {
    url: 'https://api.github.com/repos/<my_org>/<my_repo>/git/trees/?tree=main',
    status: 404,
    headers: {
    ....
  },
  data: {
      message: 'Not Found',
      documentation_url: 'https://docs.github.com/rest/git/trees#get-a-tree',
      status: '404'
    }

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
Unless I'm misunderstanding how to use this API, it appears to be a bug.

Lingua principale
TypeScript
Stelle
5k
Fork
586
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di actions/github-script

Tutte le issue di actions/github-script

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.