Skip to content

Improve docs and errors regarding github_token #4

@jamescallumyoung

Description

@jamescallumyoung

github_token is listed as optional but required in some cases. When it required is not documented but in my usage I found it was needed at least when using Cloudflare DNS.

Additionally if github_token is required but not provided, an error message is provided. In this error message, the field is refered to as github-token (note the dash) instead of github_token. This can lead to ambiguity as to which field to use.


Example error when github_token is not provided:

Error: Unhandled error: Error: Input required and not supplied: github-token

Example warning when github-token is provided instead of github_token:

Warning: Unexpected input(s) 'github-token', valid inputs are ['cid', 'dnslink_domain', 'cf_record_id', 'cf_zone_id', 'cf_auth_token', 'dnsimple_token', 'dnsimple_account_id', 'set_github_status', 'github_token']

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions