github/hubot-scripts

IMPORTANT: No longer accepting new scripts to this package, create external packages instead

tombell opened this issue · 23 comments

tombell commented

Please read https://github.com/github/hubot-scripts/blob/master/CONTRIBUTING.md if you're submitting a pull request for a new script, but basically new scripts aren't accepted.

We recommend hubot script packages now. Please check out the hubot-scripts organization for more details.

Once you've created a repository, you can file an issue against hubot-scripts/packages to have it forked to hubot-scripts, as well as to be added to the organization in order to maintain the fork.

See #1641 for current efforts to find extractions of scripts in this repository for npm packages

*Edit by @technicalpickles 2016-05-06: cross out out of date info, link to most recent deprecation efforts

technicalpickles commented

Updated original issue to mention hubot-scripts/packages, the repository.

tombell commented

👍

patcon commented

@technicalpickles Perhaps we could add a recommended way to deprecate scripts in this repo that move into npm packages? Would that go in CONTRIBUTING.md?

technicalpickles commented

I posted this in #1175 (comment) :

You can just call robot.logger.warning inside the modules.exports = (robot) -> call.

Not sure where the best place for that would be.

ibroadfo commented

It would be useful if the readme could be updated with the new recommended installation method.

technicalpickles commented

What do you mean exactly? Are you talking about the yeoman generator, or just that scripts are being moved to new packages?

ibroadfo commented

the new packages thing, yes. the hubot-scripts organisation isn't mentioned
at all, or that the user should use external-scripts.json to pull them in.

now that i think about it, i should really just throw together a PR.

On 10 February 2014 22:05, Josh Nichols notifications@github.com wrote:

What do you mean exactly? Are you talking about the yeoman generator, or
just that scripts are being moved to new packages?

Reply to this email directly or view it on GitHubhttps://github.com//issues/1113#issuecomment-34688386
.

technicalpickles commented

Would appreciate it :) Worth noting that github/hubot's docs already talk about using external packages.

On February 10, 2014 at 5:24:07 PM EST, Iain D Broadfoot wrote:the new packages thing, yes. the hubot-scripts organisation isn't mentioned at all, or that the user should use external-scripts.json to pull them in. now that i think about it, i should really just throw together a PR. On 10 February 2014 22:05, Josh Nichols notifications@github.com wrote: > What do you mean exactly? Are you talking about the yeoman generator, or > just that scripts are being moved to new packages? > > -- > Reply to this email directly or view it on GitHubhttps://github.com//issues/1113#issuecomment-34688386 > . > —Reply to this email directly or view it on GitHub.

technicalpickles commented

Renamed this issue to reflect it's intent.

technicalpickles commented

Since we continue to see PRs for new scripts, I've added a note to the description of this repo pointing to this issue.

constantx commented

any doc on how to properly load the new external scripts from @hubot-scripts ?

technicalpickles commented

@constantx https://github.com/github/hubot/blob/master/docs/scripting.md#npm-packages should cover it. It's recommended that external scripts document how to add that as well.

constantx commented

@technicalpickles in the example, the hubot-botriot line doesnt have a version number with it, is that intended?

hubot_scripting_md_at_master_ _github_hubot

technicalpickles commented

That would install any version of botriot. Probably not the best example, but it is valid.

Going forward, I tend to use npm --save hubot-whatever, which would grab the latest, and add that specific version to package.json.

constantx commented

sweet ;)

I notice @hubot-scripts doesn't have a redis brain package yet… any reliable one I should use?

technicalpickles commented

@constantx there is only one script I know of, https://github.com/github/hubot-scripts/blob/master/src/scripts/redis-brain.coffee . I should extract that to it's own repository on hubot-scripts as part of hubotio/hubot#764

dshack commented

The first comment here says "We recommend hubot script packages now. Please check out the hubot-scripts organization for more details." However, if you click the organization there's no top-level readme page.

Would it be appropriate to edit the main hubot or hubot-scripts repo to read something like this?

We've moved to a new system for adding hubot scripts. Just find the appropriate script in the hubot-scripts organization, and follow the configuration instructions. In general, this will be something like:

  1. Add a line to external-scripts.json
  2. Add a line to package.json
  3. Potentially, edit some config variables
technicalpickles commented

I haven't seen any more PRs for new scripts in the last month or so, so I think we can close this now.

I did update the README to contain some of the language suggested by @dshack. Thanks for that!

patcon commented

👍

juanbrujo commented

How to handle API-KEY's when a script is required in hubot-scripts.json? brewerydb.coffee needs API key but where I can define it? as a global variable somewhere in hubot?

MrKeiKun commented

Hi how to load customize hubot-script now?
like before you can just put .coffee file inside myhubot/scripts/
then enable it via adding the file to hubot-scripts.json
But now, I tried doing it, it failed.

patcon commented

Hi @MrKeiKun! I'm not using hubot right now, but fwiw, github (and issue tracker) etiquette is to open a new issue for questions and comments not directly related to the issue topic (in this case: the org "No longer accepting new scripts to this package")

You should probably create a new one :) (ping me in the issue, and I'll try to help you troubleshoot)