Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update automatically-redelivering-failed-deliveries-for-a-github-app-… #33220

Closed
wants to merge 1 commit into from

Conversation

garfield69
Copy link

@garfield69 garfield69 commented May 29, 2024

…webhook.md

update docs to prevent Error [ERR_REQUIRE_ESM]: require() of ES Module

Why:

Closes: https://github.com/orgs/community/discussions/126156

What's being changed (if available, include any code snippets, screenshots, or gifs):

replacing const { App, Octokit } = require("octokit"); with import { App, Octokit } from "octokit"; to prevent node.js error
See the discussion ticket I raised above for more details

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

…webhook.md

update docs to prevent Error [ERR_REQUIRE_ESM]: require() of ES Module
Copy link

welcome bot commented May 29, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 29, 2024
Copy link
Contributor

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review webhooks Content related to webhooks and removed triage Do not begin working on this issue until triaged by the team labels May 29, 2024
@nguyenalex836
Copy link
Contributor

@garfield69 Thanks so much for opening a PR! I'll get this triaged for review ✨

@ordartur111

This comment was marked as spam.

@skedwards88
Copy link
Contributor

Thanks for this PR! The syntax depends on whether you are using ES6 or not and how your project is configured. Since there isn't a one-size-fits-all solution, it may be better to just add a sentence before the example noting that this example uses CommonJS syntax. I'm going to close out this PR, but you are welcome to open another PR to add that information. (If you do, we should do the same for Automatically redelivering failed deliveries for an organization webhook - GitHub Docs and Automatically redelivering failed deliveries for a repository webhook - GitHub Docs.

@skedwards88 skedwards88 closed this Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review webhooks Content related to webhooks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants