GH Forms Options

gh-form

Disable auto rebase (enabled by default) see github documentations

type

attribute set of (submodule)

example

{
  gh-form = {
    testing = {
      assignees = [
        "hugosenari"
      ];
      checkboxes = {
        some-check = {
          description = "test gh forms checkboxes";
          label = "some check";
          options = [
            "some option"
          ];
          required = true;
          required-options = [
            "some required option"
          ];
        };
      };
      description = "Testing GH Form";
      dropdown = {
        some-dropdown = {
          description = "test gh forms dropdown";
          label = "some dropdowns";
          multiple = true;
          options = [
            "some other option"
          ];
          required = true;
        };
      };
      input = {
        some-input = {
          description = "to test gh forms inputs";
          label = "some input";
          placeholder = "Hold!!!";
          required = true;
          value = "Valuable";
        };
      };
      labels = [
        "testing"
      ];
      markdown = {
        some-markdown = {
          value = ''
            # Im a markdown
            
            I will will be displayed at form page
            I'm not intented to be filled by user, only displayed to user
          '';
        };
      };
      text = {
        some-text = {
          description = "to test gh forms texts";
          label = "some text";
          placeholder = "some bash!!!";
          render = "bash";
          required = true;
          value = ''
            echo "Hello World"
          '';
        };
      };
      title = "testing: ";
    };
  };
}

default

{
  gh-form = { };
}

gh-form.<name>.assignees

List of assignees to this kind of issue

see github documentations

type

list of non-empty string

example

{
  gh-form.<name>.assignees = [
    "hugosenari"
  ];
}

default

{
  gh-form.<name>.assignees = [ ];
}

gh-form.<name>.checkboxes

Github forms body dropdown fields

gh-forms.<file-name>.checkboxes.<field-id>.label = "<label>"; gh-forms.<file-name>.checkboxes.<field-id>.description = "<description>";

See github documentations

type

attribute set of (submodule)

example

{
  gh-form.<name>.checkboxes = {
    agreement = {
      description = "Check to confirm";
      label = "Are you sure?";
    };
  };
}

default

{
  gh-form.<name>.checkboxes = { };
}

gh-form.<name>.checkboxes.<name>.description

Description of checkboxes input

See github documentations

type

null or non-empty string

example

{
  gh-form.<name>.checkboxes.<name>.description = "Confirm this checking";
}

default

{
  gh-form.<name>.checkboxes.<name>.description = null;
}

gh-form.<name>.checkboxes.<name>.label

Label of checkboxes input

See github documentations

type

non-empty string

example

{
  gh-form.<name>.checkboxes.<name>.label = "Are you sure?";
}

gh-form.<name>.checkboxes.<name>.options

Values that can be checked

See github documentations

type

list of non-empty string

example

{
  gh-form.<name>.checkboxes.<name>.options = [
    "spam me"
  ];
}

default

{
  gh-form.<name>.checkboxes.<name>.options = [ ];
}

gh-form.<name>.checkboxes.<name>.required

If this text input is required

See github documentations

type

boolean

example

{
  gh-form.<name>.checkboxes.<name>.required = true;
}

default

{
  gh-form.<name>.checkboxes.<name>.required = false;
}

gh-form.<name>.checkboxes.<name>.required-options

Values that can be checked that need to be checked

See github documentations

type

list of non-empty string

example

{
  gh-form.<name>.checkboxes.<name>.required-options = [
    "I'm sure"
  ];
}

default

{
  gh-form.<name>.checkboxes.<name>.required-options = [ ];
}

gh-form.<name>.description

A description for the issue form template

see github documentations

type

non-empty string

example

{
  gh-form.<name>.description = "File a bug report";
}

gh-form.<name>.dropdown

Github forms body dropdown fields

gh-forms.<file-name>.dropdown.<field-id>.label = "<label>"; gh-forms.<file-name>.dropdown.<field-id>.description = "<description>";

See github documentations

type

attribute set of (submodule)

example

{
  gh-form.<name>.dropdown = {
    greeting-type = {
      description = "Types of greeting message";
      label = "Greeting type";
    };
  };
}

default

{
  gh-form.<name>.dropdown = { };
}

gh-form.<name>.dropdown.<name>.description

Description of dropdown input

See github documentations

type

null or non-empty string

example

{
  gh-form.<name>.dropdown.<name>.description = "Type of greeting message";
}

default

{
  gh-form.<name>.dropdown.<name>.description = null;
}

gh-form.<name>.dropdown.<name>.label

Label of dropdown input

See github documentations

type

non-empty string

example

{
  gh-form.<name>.dropdown.<name>.label = "Greeting type";
}

gh-form.<name>.dropdown.<name>.multiple

If more than one could be selected

See github documentations

type

boolean

example

{
  gh-form.<name>.dropdown.<name>.multiple = true;
}

default

{
  gh-form.<name>.dropdown.<name>.multiple = false;
}

gh-form.<name>.dropdown.<name>.options

Values that can be selected

See github documentations

type

list of non-empty string

example

{
  gh-form.<name>.dropdown.<name>.options = [
    "birthday"
    "new-year"
  ];
}

gh-form.<name>.dropdown.<name>.required

If this dropdown input is required

See github documentations

type

boolean

example

{
  gh-form.<name>.dropdown.<name>.required = true;
}

default

{
  gh-form.<name>.dropdown.<name>.required = false;
}

gh-form.<name>.input

Github forms body input fields

gh-forms.<file-name>.input.<field-id>.label = "<label>"; gh-forms.<file-name>.input.<field-id>.description = "<description>";

See github documentations

type

attribute set of (submodule)

example

{
  gh-form.<name>.input = {
    frequency = {
      description = "How many times it happens";
      label = "Frequency";
    };
  };
}

default

{
  gh-form.<name>.input = { };
}

gh-form.<name>.input.<name>.description

Description of input

See github documentations

type

null or non-empty string

example

{
  gh-form.<name>.input.<name>.description = "How many times it happens";
}

default

{
  gh-form.<name>.input.<name>.description = null;
}

gh-form.<name>.input.<name>.label

Label of input

See github documentations

type

non-empty string

example

{
  gh-form.<name>.input.<name>.label = "Frequency";
}

gh-form.<name>.input.<name>.placeholder

Placeholder for input

See github documentations

type

null or non-empty string

example

{
  gh-form.<name>.input.<name>.placeholder = "every 5 days";
}

default

{
  gh-form.<name>.input.<name>.placeholder = null;
}

gh-form.<name>.input.<name>.required

If this input is required

See github documentations

type

boolean

example

{
  gh-form.<name>.input.<name>.required = true;
}

default

{
  gh-form.<name>.input.<name>.required = false;
}

gh-form.<name>.input.<name>.value

Default value for input

See github documentations

type

null or non-empty string

example

{
  gh-form.<name>.input.<name>.value = "11 times in a week";
}

default

{
  gh-form.<name>.input.<name>.value = null;
}

gh-form.<name>.labels

Labels to this kind of issue

see github documentations

type

list of non-empty string

example

{
  gh-form.<name>.labels = [
    "bug"
    "critical"
  ];
}

default

{
  gh-form.<name>.labels = [ ];
}

gh-form.<name>.markdown

Github forms body markdown fields

gh-forms.<file-name>.markdown.<field-id>.required = true; gh-forms.<file-name>.markdown.<field-id>.value = "<value>";

See github documentations

type

attribute set of (submodule)

example

{
  gh-form.<name>.markdown = {
    some = {
      required = true;
      value = "Some markdown text";
    };
  };
}

default

{
  gh-form.<name>.markdown = { };
}

{
  gh-form.<name>.markdown.<name>.value = "11 times in a week";
}

default

{
  gh-form.<name>.markdown.<name>.value = "";
}

{
  gh-form.<name>.name = "Bug report";
}

default

{
  gh-form.<name>.name = null;
}

gh-form.<name>.text

Github forms body text fields

gh-forms.<file-name>.text.<field-id>.label = "<label>"; gh-forms.<file-name>.text.<field-id>.description = "<description>";

See github documentations

type

attribute set of (submodule)

example

{
  gh-form.<name>.text = {
    greeting = {
      description = "Insert your greeting message";
      label = "Greeting message";
    };
  };
}

default

{
  gh-form.<name>.text = { };
}

{
  gh-form.<name>.text.<name>.description = "Greeting message";
}

default

{
  gh-form.<name>.text.<name>.description = null;
}

{
  gh-form.<name>.text.<name>.label = "Greeting message";
}

{
  gh-form.<name>.text.<name>.placeholder = "Insert your long text here";
}

default

{
  gh-form.<name>.text.<name>.placeholder = null;
}

{
  gh-form.<name>.text.<name>.render = "bash";
}

default

{
  gh-form.<name>.text.<name>.render = null;
}

{
  gh-form.<name>.text.<name>.required = true;
}

default

{
  gh-form.<name>.text.<name>.required = false;
}

{
  gh-form.<name>.text.<name>.value = "Happy new year!!";
}

default

{
  gh-form.<name>.text.<name>.value = null;
}

{
  gh-form.<name>.title = "[Bug]: ";
}

default

{
  gh-form.<name>.title = null;
}