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

Configuration variables #1

Open
24 of 32 tasks
kongr45gpen opened this issue Jul 25, 2013 · 0 comments
Open
24 of 32 tasks

Configuration variables #1

kongr45gpen opened this issue Jul 25, 2013 · 0 comments

Comments

@kongr45gpen
Copy link
Owner

kongr45gpen commented Jul 25, 2013

Configuration of the plugin should be done in three stages: global, channel, repository-type-module. Repository overrides channel, which overrides global. Thankfully, supybot already provides support for channel-based config vars, we only need to code the repo ones. Type is the type of the post-receive hook (e.g.: push, gollum, pull-request, etc) and module is a name specified on the post-receive hook. Here's some examples of repository-dependent variable categories:

  1. repo-*-* (Adjust variables for the repo repository)
  2. octocat-*-sample (Adjust variables for the octocat repository when the hook URL looks something like host:port/passcode/sample)
  3. *-gollum-* (Adjust variables for all wiki edits which are not overriden)
  • Global variables
  • Channel-dependent variables
  • Repository-dependent variables
  • Type-dependent variables
  • Module-dependent variables

The plugin should have the following configuration variables (not in a specific order):

  • channel (obviously cannot be channel-based)
  • port (the server port)
  • address (the server binding address)
  • passcode (a passcode which can be used to ensure that hook updates come from the right place)
  • theme (the theme to use)
  • notify (notify instead of privmsg)
  • hidePush (hide user pushed ... commits message)
  • shortURL (use git.io to shorten the commit/compare URLs)
  • fullcommits (show full commit message, instead of just the title)
  • colors
  • commitnewline (start commit message on a new line)
  • theme (string representing the format in which messages should be sent)
  • brackets (the type of brackets to show)
  • showOwner (whether to show the name of the owner of the repo - can be never, fork or always
  • port
  • showMergedCommits
  • showSuccessfulBuildMessages (whether to show successful build messages - can be never, change or always)
  • disallowConfigOverride
  • disallowChannelOverride
  • allowArbitraryMessages
  • hideURL
  • showMilestone
  • tagShowCommitMsg
  • preventIssueNameSmap
  • showIssueEdits
  • showPendingStatuses
  • alwaysShowForcedPushes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant