{"id":16476364,"url":"https://github.com/softprops/heroic","last_synced_at":"2025-03-23T11:32:58.221Z","repository":{"id":57736624,"uuid":"2294591","full_name":"softprops/heroic","owner":"softprops","description":"zero to hero Heroku deployment for sbt","archived":false,"fork":false,"pushed_at":"2012-11-30T06:11:39.000Z","size":252,"stargazers_count":18,"open_issues_count":7,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-17T11:59:55.603Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/softprops.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-08-30T12:20:34.000Z","updated_at":"2019-08-13T14:49:30.000Z","dependencies_parsed_at":"2022-08-24T14:57:20.690Z","dependency_job_id":null,"html_url":"https://github.com/softprops/heroic","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fheroic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fheroic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fheroic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fheroic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/softprops","download_url":"https://codeload.github.com/softprops/heroic/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245097158,"owners_count":20560311,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T12:42:12.881Z","updated_at":"2025-03-23T11:32:57.828Z","avatar_url":"https://github.com/softprops.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# heroic\n\n\u003e because sometimes your scala deploy need a hero\n\nAn sbt interface for remotely administering and deploying [heroku][heroku] hosted applications\n\n## install\n\n1. For starters, you'll need an account on [heroku][signup]\n\n2. Install the sbt plugin (note not yet published)\n\nComin' at ya soon\n\n3. Deploy\n\nInside sbt you will need to first authenticate with heroku, only once (you can undo this later)\n\n    sbt\u003e hero::authenticate\n    [info] Authenticate with Heroku\n    Enter your API key (from https://dashboard.heroku.com/account): ********************************\n\nGenerate some heroku specifics for deployment using your apps `Main` class\n    \n    sbt\u003e hero::equip\n    \nCreate remote application\n\n    sbt\u003e hero::create\n    \nDeploy to it (note you can do this from the command line with `git push heroku master`)\n    \n    sbt\u003e hero::deploy\n\nTo install additional Heroku [addons](http://addons.heroku.com/) you need to [verify](https://api.heroku.com/verify) your account.\n\n## settings\n\n\n### Package settings\n\n    hero::equip        # Prepares project for Heroku deployment\n    hero::procfile     # Writes Heroku Procfile to project base directory\n    hero::script-name   # Name of script-file\n    hero::script-file   # Target process for Heroku web profile key\n    hero::script       # Generates script-file\n    hero::slug-ignored  # List of items to ignore when transfering application\n    hero::slug-ignore   # Generates a Heroku .slugignore file in the base directory\n    hero::main-class    # uses sbt's mainClass to task to resolve a main class\n    hero::java-options # seq of java options to use in script\n\nheroku uses [git][git] to manage deployements. In order to deploy your changes you need to first commit them.\n\nHeroku also exposes certain runtime properties as env vars. Of note, your Main class should start a server that listens on a port accessible via `System.getenv(\"PORT\").toInt`.\n\n### Client Settings\n\n(More will be added in the in the future)\nNote: This plugin supports multiple deployment environments (i.e. multiple Heroku remotes) The default Heroku env is named heroku. A common pattern for application development is to publish to a staging env before deploying to production. You can create a named Heroku env with `hero-create \u003cenv\u003e`. The arguments of the keys below will default the the heroku env. Simply use your own env name when modifying that env (`hero-conf-add \u003cenv\u003e \u003ckey\u003e \u003cval\u003e`)\n\n     hero::check-dependencies # tests to see if all required dependencies are resolvable\n     hero::addons     # lists installed addons for app\n     hero::addons-available # lists all available addons\n     hero::addons-add # installs an addon\n     hero::addons-rm  # uninstalls an addon\n     hero::create     # shells out to heroku to create a new `stack`. This will add a git remote named heroku to your\n                     # git repo\n     hero::collaborators # lists all collabs\n     hero::collaborators-add # adds a collab\n     hero::collaborators-rm  # removes a collab\n     hero::config       # lists remote config (env) vars\n     hero::config-add   # adds a remote config var\n     hero::config-rm    # removes a remote config var\n     hero::destroy    # deletes remote heroku application\n     hero::domains    # lists heroku domains\n     hero::domains-add # adds heroku domain\n     hero::domains-rm # removes heroku domain\n     hero::deploy       # pushes application to heroku\n     hero::ps         # fetches remote process info\n     hero::local-hero # runs local instance of app based on procfile definition\n     hero::logs       # fetches remote log info\n     hero::addons     # lists current Heroku addons\n     hero::addons-add # adds a Heroku addon by name (requires payment validation on site)\n     hero::addons-rm  # removes a Heroku addon by name\n     hero::addons-upgrade # upgrades a target addon\n     hero::info       # renders heroku info\n     hero::keys       # lists registered ssh keys\n     hero::releases   # listing of all releases\n     hero::release-info # provides config info about a target release\n     hero::rollback   # rollback to target release\n     hero::rename     # changes heroku application name (subdomain)\n     hero::maint-on   # enables Heroku maintenance mode\n     hero::maint-off  # disables Heroku maintenance mode\n\n* heroku requires a few files in your projects base directly. speficially a `build.properties` sbt config file under the `project` directory or your projects base\n\n### tl;dr\n\n1) run once cmds\n   $ git init\n   sbt\u003e hero::equip\n   sbt\u003e hero::create\n\n2) git commit your code\n   sbt\u003e hero::deploy\n\n3) keep coding\n\n4) goto 2\n\n## dependencies\n\n`git`\n\n## todo\n\n- cache locally what I know doesn't change. (every client call is a remote api call)\n\nDoug Tangren (softprops) 2011-2012\n\n[git]: http://git-scm.com/\n[heroku]: http://www.heroku.com/\n[signup]: https://api.heroku.com/signup\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftprops%2Fheroic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftprops%2Fheroic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftprops%2Fheroic/lists"}