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

[BUG]: Old Secrets Link Used in Types documentation comments #179

Open
dthyresson opened this issue Apr 25, 2023 · 0 comments
Open

[BUG]: Old Secrets Link Used in Types documentation comments #179

dthyresson opened this issue Apr 25, 2023 · 0 comments
Labels
Bug Something isn't working 📦 inngest Affects the `inngest` package

Comments

@dthyresson
Copy link

Describe the bug

Related to 164fd5c

See: "@link https://app.inngest.com/secrets}" is still old link

export interface RegisterOptions {
  /**
   * A key used to sign requests to and from Inngest in order to prove that the
   * source is legitimate.
   *
   * You must provide a signing key to communicate securely with Inngest. If
   * your key is not provided here, we'll try to retrieve it from the
   * `INNGEST_SIGNING_KEY` environment variable.
   *
   * You can retrieve your signing key from the Inngest UI inside the "Secrets"
   * section at {@link https://app.inngest.com/secrets}. We highly recommend
   * that you add this to your platform's available environment variables as
   * `INNGEST_SIGNING_KEY`.
   *
   * If no key can be found, you will not be able to register your functions or
   * receive events from Inngest.
   */
  signingKey?: string;

Should be:

"https://app.inngest.com/env/production/manage/signing-key"

Expected behavior

The links should match.

The dev server was updated, but the code docs still have old link.

@dthyresson dthyresson added the Bug Something isn't working label Apr 25, 2023
@jpwilliams jpwilliams added the 📦 inngest Affects the `inngest` package label Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working 📦 inngest Affects the `inngest` package
Projects
None yet
Development

No branches or pull requests

2 participants