Hello, I'm trying to debug this error I'm consistently running into when using @actions/github in a custom action in my repositories. What's odd is that the exact code works fine in one repo, but not in the other. It's the same action, just copied over. There error is below and seems to stem from this package, but it could also be something else happening in the runner. Any help would be awesome!

internal/modules/cjs/loader.js:305
22
      throw err;
23
      ^
24

25
Error: Cannot find module '/home/runner/work/graphql/graphql/.github/actions/terraform-run/node_modules/is-plain-object/dist/is-plain-object.js'. Please verify that the package.json has a valid "main" entry
26
    at tryPackage (internal/modules/cjs/loader.js:297:19)
27
    at Function.Module._findPath (internal/modules/cjs/loader.js:528:18)
28
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:784:27)
29
    at Function.Module._load (internal/modules/cjs/loader.js:690:27)
30
    at Module.require (internal/modules/cjs/loader.js:852:19)
31
    at require (internal/modules/cjs/helpers.js:74:18)
32
    at Object.<anonymous> (/home/runner/work/graphql/graphql/.github/actions/terraform-run/node_modules/@octokit/endpoint/dist-node/index.js:5:21)
33
    at Module._compile (internal/modules/cjs/loader.js:959:30)
34
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:995:10)
35
    at Module.load (internal/modules/cjs/loader.js:815:32) {
36
  code: 'MODULE_NOT_FOUND',
37
  path: '/home/runner/work/graphql/graphql/.github/actions/terraform-run/node_modules/is-plain-object/package.json',
38
  requestPath: 'is-plain-object'
39
}

I guess we need to review the required check runs for this repository

Example

const { url: url1 } = endpoint("GET /repos/{owner}/{repo}/contents/{path}", {
  owner: "owner",
  repo: "repo",
  path: "path/to/file.txt"
});
const { url: url2 } = endpoint("GET /repos/:owner/:repo/contents/:path", {
  owner: "owner",
  repo: "repo",
  path: "path/to/file.txt"
});

• url1 is https://api.github.com/repos/owner/repo/contents/path%2Fto%2Ffile.txt
• url2 is https://api.github.com/repos/owner/repo/contents/path/to/file.txt

url1 is correct.

I'd appreciate a pull request if anyone would like to work on this. You can start out by creating a pull request with a failing test reproducing the above behavior. The test will go into test/endpoint.test.ts.

The endpoint() method currently returns body as the key holding the request body. We should rename it to data to align with data parameter in @octokit/request: https://github.com/octokit/request.js/#the-data-parameter--set-request-body-directly

We can start by setting both .data and .body and then logging a deprecation message when .body is accessed.

The "unpkg" field does not point to the bundled file https://unpkg.com/@octokit/[email protected]/package.json

Hello,

I've been trying to use the new @actions/github, which allows me to create a new octokit instance and call various api methods. I've been attempting to use release apis.

The custom action i'm using is a local action, stored inside the repository.
An attempt to use the action triggers an error:

Run ./.github/actions/release-upload
/Users/runner/runners/2.157.5/work/myproject/.github/actions/release-upload/node_modules/@octokit/endpoint/dist-node/index.js:360
const userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`;
                                                                       ^

TypeError: universalUserAgent.getUserAgent is not a function
    at Object.<anonymous> (/Users/runner/runners/2.157.5/work/myproject/.github/actions/release-upload/node_modules/@octokit/endpoint/dist-node/index.js:360:72)
    at Module._compile (internal/modules/cjs/loader.js:774:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:785:10)
    at Module.load (internal/modules/cjs/loader.js:641:32)
    at Function.Module._load (internal/modules/cjs/loader.js:556:12)
    at Module.require (internal/modules/cjs/loader.js:681:19)
    at require (internal/modules/cjs/helpers.js:16:16)
    at Object.<anonymous> (/Users/runner/runners/2.157.5/work/myproject/.github/actions/release-upload/node_modules/@octokit/request/dist-node/index.js:7:16)
    at Module._compile (internal/modules/cjs/loader.js:774:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:785:10)
##[error]Node run failed with exit code 1

Now, seems to me that the error is caused by the fact that the "compiled" js version of the package universal-user-agent has main pointing to the file that actually returns a function, rather than an object.

part of universal-user-agent's package.json (inside node_modules for @octokit/endpoint):

  ...
  "homepage": "https://github.com/gr2m/universal-user-agent#readme",
  "keywords": [],
  "license": "ISC",
  "main": "dist-node/index.js",
  "module": "dist-web/index.js",
  "name": "universal-user-agent",
  "pika": true,
  ...

Also that issue seems to be related to the gr2m/universal-user-agent#23

Thank you!

What happened?

> const { endpoint } = require("@octokit/endpoint");
> endpoint("http://api.github.com/repos/octocat/Hello-World/branches{/branch}", {})
{
  method: 'GET',
  url: 'http://api.github.com/repos/octocat/Hello-World/branches/',
  headers: {
    accept: 'application/vnd.github.v3+json',
    'user-agent': 'octokit-endpoint.js/7.0.4 Node.js/19.4.0 (linux; x64)'
  }
}

Note the slash at the end of url. GitHub returns 404 for .../branches/, but lists branches for .../branches.

Expanding the same URL with url-template and empty context returns .../branches. This makes me belive that endpoint.js performs template expansion incorrectly.

Versions

Octokit.js v7.0.4, Node v19.4.0

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

I'm using webpack 4.26.1 with rest.js, but after a successful bundling the application encountered this error TypeError: merge.all is not a function.

Then I tried the TypeScript compiler, while it works perfect.

I've found the simillar issue(#1129 ), but it doesn't help at all.

Here is the error stack:

TypeError: merge.all is not a function
	at defaultOptions (webpack:///./node_modules/@octokit/endpoint/lib/merge.js?:19:19)
	at withDefaults (webpack:///./node_modules/@octokit/endpoint/with-defaults.js?:8:20)
	at eval (webpack:///./node_modules/@octokit/endpoint/index.js?:4:18)
	at Object../node_modules/@octokit/endpoint/index.js (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:96:1)
	at __webpack_require__ (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:20:30)
	at eval (webpack:///./node_modules/@octokit/request/index.js?:1:18)
	at Object../node_modules/@octokit/request/index.js (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:217:1)
	at __webpack_require__ (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:20:30)
	at eval (webpack:///./node_modules/@octokit/rest/lib/constructor.js?:3:18)
	at Object../node_modules/@octokit/rest/lib/constructor.js (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:306:1)
	at __webpack_require__ (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:20:30)
	at eval (webpack:///./node_modules/@octokit/rest/lib/factory.js?:3:17)
	at Object../node_modules/@octokit/rest/lib/factory.js (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:328:1)
	at __webpack_require__ (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:20:30)
	at eval (webpack:///./node_modules/@octokit/rest/lib/core.js?:1:17)
	at Object../node_modules/@octokit/rest/lib/core.js (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:317:1)
	at __webpack_require__ (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:20:30)
	at eval (webpack:///./node_modules/@octokit/rest/index.js?:1:17)
	at Object../node_modules/@octokit/rest/index.js (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:295:1)
	at __webpack_require__ (/Users/Zoro/Workspace/vscode-syncing/dist/extension.js:20:30)

After debugging into the package deepmerge, I got this:

Note that the webpack imports the deepmerge from "./node_modules/deepmerge/dist/es.js", which is an ES module. But it doesn't extract the merge object from the default property of the imported ES module.
Thus, calling merge.all will raise the error, instead it should be called as merge.default.all, but of cause it cannot be an acceptable solution.

This issue contains a list of Renovate updates and their statuses.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to ignore the schedule.

• fix(deps): lock file maintenance

• Check this box to trigger a request for Renovate to run again on this repository

The devDependency cypress was updated from 3.1.2 to 3.1.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

cypress is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

trying to upgrade lerna to v17 and this is the last thing that depends on old types (I think)

lerna/lerna#2600

See lerna/lerna#2065

ooops

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: package.json
Error type: The renovate configuration file contains some invalid settings
Message: Configuration option 'packageRules[1].npm' should be a json object, Invalid configuration option: @pika/pack, Invalid configuration option: author, Invalid configuration option: jest, Invalid configuration option: keywords, Invalid configuration option: license, Invalid configuration option: name, Invalid configuration option: packageRules[0].@pika/pack, Invalid configuration option: packageRules[0].@pika/plugin-build-node, Invalid configuration option: packageRules[0].@pika/plugin-build-web, Invalid configuration option: packageRules[0].@pika/plugin-ts-standard-pkg, Invalid configuration option: packageRules[0].@types/jest, Invalid configuration option: packageRules[0].jest, Invalid configuration option: packageRules[0].prettier, Invalid configuration option: packageRules[0].semantic-release, Invalid configuration option: packageRules[0].semantic-release-plugin-update-version-in-files, Invalid configuration option: packageRules[0].ts-jest, Invalid configuration option: packageRules[0].typescript, Invalid configuration option: packageRules[1].@octokit/types, Invalid configuration option: packageRules[1].i, Invalid configuration option: packageRules[1].is-plain-object, Invalid configuration option: packageRules[1].universal-user-agent, Invalid configuration option: publishConfig, Invalid configuration option: release, Invalid configuration option: renovate, Invalid configuration option: scripts, Invalid configuration option: version, The "npm" object can only be configured at the top level of a config but was found inside "packageRules[1]"

The current bundle size is 9.15KB, minified and gzipped. I’m sure there are ways to further reduce the file size. To test it locally, you can run

npm run build
npx bundlesize

There is also a built-in bundle report which tells you where the most of size is coming from

npm run bundle-report
# then open ./dist/bundle-report.html

Description

Node v10 has been deprecated so there is no need to keep giving support to it in our CI.

Context

You can find more details here

This is a follow up for octokit/request.js#38. I think it makes sense to implement these in @octokit/endpoint, to simplify setting / defaulting of request media types

The devDependency webpack was updated from 4.26.1 to 4.27.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Describe the need

placeholder issue for the existing PR #457

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

compare setup of https://github.com/octokit/rest.js. This library is meant to be in browsers as a minimal library to interact with GitHub’s rest API. A small bundle size is a very important feature.

Once we know the size of the bundle, mention it in the README as a feature :D

🆕🐥☝ First Timers Only.

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

About First Timers Only.

🤔 What you will need to know.

The Pika CDN is now Skypack, see https://www.pika.dev/cdn. The CDN at https://cdn.pika.dev/ no longer works, all URLs must be replaced with the new CDN: https://cdn.skypack.dev/. We currently recommend using cdn.pika.dev to import the library into the browser, but that no longer works. Replacing it with cdn.skypack.dev will make it work again.

📋 Step by Step

• 🙋 Claim this issue: Comment below.

  More than one person can work on this issue, don't worry if it's already claimed.

• 📝 Update the file \README.md (press the little pen Icon) and edit as shown below:

@@ -32,11 +32,11 @@
 <tr><th>
 Browsers
 </th><td width=100%>
-Load <code>@octokit/endpoint</code> directly from <a href="https://cdn.pika.dev">cdn.pika.dev</a>
+Load <code>@octokit/endpoint</code> directly from <a href="https://cdn.skypack.dev">cdn.skypack.dev</a>
         
 ```html
 <script type="module">
-import { endpoint } from "https://cdn.pika.dev/@octokit/endpoint";
+import { endpoint } from "https://cdn.skypack.dev/@octokit/endpoint";
 </script>
 ```

• 💾 Commit your changes

• 🔀 Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.
  2. You can edit files directly in your browser

• 🏁 Done Ask for a review :)

If there are more than one pull requests with the correct change, we will merge the first one, but attribute the change to all authors who made the same change using @Co-authored-by, so yo can be sure your contribution will count.

🤔❓ Questions

Leave a comment below!

This issue was created by First-Timers-Bot.

Hello, Thanks for develop a useful library. I have always used octokit.js when using GitHub's API with JavaScript.

What happened?

I recently tried to update webhook settings of the GitHub App when it failed, because the request URL had been rewritten with an optional parameter "url". The GitHub API I used is here.

await octokit.apps.updateWebhookConfigForApp({
    url: "https://example.com",
});

/node_modules/@octokit/request/dist-node/index.js:86
      const error = new requestError.RequestError(toErrorMessage(data), status, {
                    ^

RequestError [HttpError]
    at /node_modules/@octokit/request/dist-node/index.js:86:21
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async sendRequestWithRetries (/node_modules/@octokit/auth-app/dist-node/index.js:376:12)
    at async Job.doExecute (/node_modules/bottleneck/light.js:405:18) {
  status: 405,
  response: {
    url: 'https://example.com/',
    status: 405,
    headers: {
      'cache-control': 'max-age=604800',
      connection: 'close',
      'content-length': '0',
      'content-type': 'text/html; charset=UTF-8',
      date: 'Wed, 05 Oct 2022 03:15:29 GMT',
      expires: 'Wed, 12 Oct 2022 03:15:29 GMT',
      server: 'EOS (vny/0453)'
    },
    data: ''
  },
  request: {
    method: 'PATCH',
    url: 'https://example.com',
    headers: {
      accept: 'application/vnd.github.v3+json',
      'user-agent': 'probot/12.2.8 octokit-core.js/3.6.0 Node.js/16.11.0 (darwin; arm64)',
      authorization: 'token [REDACTED]',
      'content-length': 0
    },
    body: '',
    request: {
      hook: [Function: bound bound register],
      retryCount: 3,
      retries: 3,
      retryAfter: 16
    }
  }
}

The request url is "https://example.com". This problem is caused by overwriting the url with an optional url in endpoint.merge using by Object.assign.
https://github.com/octokit/endpoint.js/blob/master/src/merge.ts#L14

reproducible test case: https://runkit.com/kuroppe1819/633c4007c4b5ac0008e59295

Proposal

Update my GitHub App webhook url by using octokit.js. In order to do that wish to solve the problem of not being able to add URL parameters to the request body.

How about an approach that allows the body_url parameter to be specified, e.g.

const merged = endpoint.merge("PATCH /app/hook/config", {
    body_url: "https://example.com"
});
const parsed = endpoint.parse(merged);

console.log(parsed);
// expect
// {
//   method: "PATCH",
//   url: "https://api.github.com/app/hook/config",
//   headers: {
//     accept: "application/vnd.github.v3+json",
//     user-agent: "octokit-endpoint.js/7.0.2 Node.js/14.20.1 (linux; x64)"
//   },
//   body: {
//     url: "https://example.com"
//   }
// }

or body object to merge function argument.

const merged = endpoint.merge("PATCH /app/hook/config", {
  content_type: "json",
  body: {
    url: "https://example.com",
    secret: "XXXX"
  }
});
const parsed = endpoint.parse(merged);

console.log(parsed);
// expect
// {
//   method: "PATCH",
//   url: "https://api.github.com/app/hook/config",
//   headers: {
//     accept: "application/vnd.github.v3+json",
//     user-agent: "octokit-endpoint.js/7.0.2 Node.js/14.20.1 (linux; x64)"
//   },
//   body: {
//     content_type: "json",
//     url: "https://example.com",
//     secret: "XXXX"
//   }
// }

if merge method or parse method interface are able to change it, I think more good approach to do proposal. First, I have suggested a safe implementation. If you have a cooler implementation, please advise.

The devDependency mocha was updated from 6.0.2 to 6.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

mocha is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Example

const requestOptions = endpoint("GET /repos/{owner}/{repo}/contents/{path}", {
  owner: "owner",
  repo: "repo",
  path: "path/to/file.txt",
  ref: undefined,
});

requestOptions.url is now "https://api.github.com/repos/owner/repo/contents/path%2Fto%2Ffile.txt?ref=undefined", but should be just "https://api.github.com/repos/owner/repo/contents/path%2Fto%2Ffile.txt"

I'd appreciate a pull request if anyone would like to work on this. You can start out by creating a pull request with a failing test reproducing the above behavior. The test will go into test/endpoint.test.ts.

Today, TypeScript does not complain about this

endpoint("GET /orgs/:org");

But it should, because the org parameter is required. If "GET /orgs/:org" is set, then TypeScript should complain that only one of two parameters is set and only chill once the code is

endpoint("GET /orgs/:org", {
  org: 'my-org'
});

I'll get to this myself eventually, but if anyone wants to give that a go, just comment and give it a go :)

🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 💜 🚚💨 💚

Find out how to migrate to Snyk at greenkeeper.io

The dependency @octokit/types was updated from 2.16.0 to 2.16.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@octokit/types is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

I was very cautious to write libraries in Typescript, I was always thinking that it might increase barriers to contributors. But we won’t get around having typescript definitions and the constant problems that occur due to JavaScript code being out-of-sync with the Typescript definitions I think it’s time to embrace Typescript.

If you have any concerns, now is the time to raise them. I’ll probably rewrite all @octokit/* libraries to Typescript.

I started experimenting with Typescript definitions for @ocotkit/endpoint a while ago:

type KnownRoute = 
    | 'GET /foo'
    | 'POST /foo'
type Method = 
    | 'DELETE'
    | 'GET'
    | 'HEAD'
    | 'PATCH'
    | 'POST'
    | 'PUT'
type KnownPath =
    | '/foo'
type Options = {
    headers?: Object,
    request?: Object,
    baseUrl?: string,
    data?: any
    [option: string]: any
}
type KnownRouteOptions = {
    method: Method,
    url: KnownPath
}
type CustomRouteOptions = {
    method: Method,
    url: string
}
type RequestOptions = {
    method: Method,
    url: string,
    headers: object,
    body?: any,
    request?: object
}

type GetFooRoute = 'GET /foo'
type GetFooOptions = {
    headers?: object,
    request?: object,
    bar: string,
    baz:
        | 'one'
        | 'two'
        | 'three'
}
type GetFooRequestOptions = {
    method: 'GET',
    url: string,
    headers: object,
    request?: object
}

/**
 * Super funky fresh!
 * 
 * @param route funky
 * @param options fresh
 */
function endpoint (route: GetFooRoute, options: GetFooOptions): GetFooRequestOptions;
function endpoint (route: KnownRoute, options?: Options): RequestOptions;
function endpoint (route: string, options?: Options): RequestOptions;
function endpoint (options: Options & KnownRouteOptions): RequestOptions;
function endpoint (options: Options & CustomRouteOptions): RequestOptions;
function endpoint (route?, options?): RequestOptions {
    return {
        method: 'GET',
        url: '/foo',
        headers: {}
    }
}

My thinking is that we could use @octokit/routes to generate typescript definitions for every known route, I think that would provide a very sleek developer experience.

The same definitions can be inherited by @octokit/request, so people might end up just using this library in order to minimize their bundle size, but still have nice typeahead experience.

The devDependency nyc was updated from 13.1.0 to 13.2.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

nyc is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

We only support it for legacy reasons. GitHub is no longer documenting the REST API endpoints using the :name notation for a long time now. We should remove support for it as well.

The devDependency webpack-bundle-analyzer was updated from 3.0.3 to 3.0.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack-bundle-analyzer is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency semantic-release was updated from 15.12.3 to 15.12.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency webpack was updated from 4.29.0 to 4.29.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴