{"id":16368579,"url":"https://github.com/simoneb/grunt-git-s3-heroku","last_synced_at":"2026-02-26T20:30:15.450Z","repository":{"id":17598720,"uuid":"20402432","full_name":"simoneb/grunt-git-s3-heroku","owner":"simoneb","description":null,"archived":false,"fork":false,"pushed_at":"2016-02-20T23:06:31.000Z","size":136,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-31T11:18:44.590Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/simoneb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-02T12:00:36.000Z","updated_at":"2014-06-02T22:37:17.000Z","dependencies_parsed_at":"2022-09-11T18:22:54.100Z","dependency_job_id":null,"html_url":"https://github.com/simoneb/grunt-git-s3-heroku","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simoneb%2Fgrunt-git-s3-heroku","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simoneb%2Fgrunt-git-s3-heroku/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simoneb%2Fgrunt-git-s3-heroku/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simoneb%2Fgrunt-git-s3-heroku/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simoneb","download_url":"https://codeload.github.com/simoneb/grunt-git-s3-heroku/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239869222,"owners_count":19710485,"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-11T02:53:10.833Z","updated_at":"2026-02-26T20:30:15.392Z","avatar_url":"https://github.com/simoneb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-git-s3-heroku\n\n\u003e Deploy a git-versioned application to Heroku via AWS S3\n\n## Getting Started\nThis plugin requires Grunt `~0.4.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-git-s3-heroku --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-git-s3-heroku');\n```\n\n## The \"git_s3_heroku\" task\n\n### Overview\nIn your project's Gruntfile, add a section named `git_s3_heroku` to the data object passed into `grunt.initConfig()`.\n\n```js\ngrunt.initConfig({\n  git_s3_heroku: {\n    options: {\n      // Task-specific options go here.\n    },\n    your_target: {\n      // Target-specific file lists and/or options go here.\n    },\n  },\n});\n```\n\n### How it works\n\nThis plugin deploys a git-versioned application to Heroku via S3. Here's how it does it:\n\n1. run `git describe` to create a name for the package\n2. run `git archive` to create the package\n3. upload the package to AWS S3\n4. deploy the package to Heroku using the Heroku Platform API\n\n### Options\n\n#### options.gitDescribeArgs\nType: `Array`, `Function`\nDefault value: `[]`\n\nCommand line args to supply to `git describe`. Common options are `--always` and `--dirty`.  \nWhen a function is supplied it should return a string containing all args.\n\n#### options.packageDir\nType: `String`\nDefault value: `os.tmpdir()`\n\nThe folder in which the temporary package is saved before being uploaded to S3.\n\n#### options.accessKeyId\nType: `String`\nDefault value: `process.env.AWS_ACCESS_KEY_ID`\n\nThe AWS access key id.\n\n#### options.secretAccessKey\nType: `String`\nDefault value: `process.env.AWS_SECRET_ACCESS_KEY`\n\nThe AWS secret access key.\n\n#### options.s3Bucket\nType: `String`\n\nThe name of the AWS S3 bucket where to upload the packaged application.\n\n#### options.s3Acl\nType: `String`\nDefault value: `public-read`\n\nThe AWS S3 ACL to apply to the uploaded object.\n\n#### options.herokuAppName\nType: `String`\n\nThe name of the heroku application.\n\n#### options.herokuApiToken\nType: `String`\nDefault value: `process.env.HEROKU_API_TOKEN`\n\nThe API token to use to authenticate to the heroku platform API.\n\n### Usage Examples\n\n```js\ngrunt.initConfig({\n  git_s3_heroku: {\n    myApp: {\n      gitDescribeArgs: ['--always'],\n      s3Bucket: 'my-bucket',\n      herokuAppName: 'my-app'\n    }\n  },\n});\n```\n\n## Contributing\nIn lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).\n\n## Release History\n03/06/2014    v0.1.0    Initial release\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimoneb%2Fgrunt-git-s3-heroku","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimoneb%2Fgrunt-git-s3-heroku","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimoneb%2Fgrunt-git-s3-heroku/lists"}