{"id":23131675,"url":"https://github.com/peopledoc/ember-cli-deploy-index-json","last_synced_at":"2025-04-04T07:28:25.701Z","repository":{"id":34433022,"uuid":"110819056","full_name":"peopledoc/ember-cli-deploy-index-json","owner":"peopledoc","description":"An Ember CLI Deploy plugin to use a JSON index rather than an HTML one as provided by ember-cli-deploy-s3-index.","archived":false,"fork":false,"pushed_at":"2023-10-17T01:26:46.000Z","size":1428,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-22T20:38:27.730Z","etag":null,"topics":["approved-public","ember-addon","ember-cli-deploy","ember-cli-deploy-plugin","ghec-mig-migrated","peopledoc-opensource","tribe-js"],"latest_commit_sha":null,"homepage":"","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/peopledoc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-15T10:26:25.000Z","updated_at":"2023-09-27T19:10:12.000Z","dependencies_parsed_at":"2025-02-09T18:40:51.169Z","dependency_job_id":null,"html_url":"https://github.com/peopledoc/ember-cli-deploy-index-json","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/peopledoc%2Fember-cli-deploy-index-json","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peopledoc%2Fember-cli-deploy-index-json/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peopledoc%2Fember-cli-deploy-index-json/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peopledoc%2Fember-cli-deploy-index-json/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peopledoc","download_url":"https://codeload.github.com/peopledoc/ember-cli-deploy-index-json/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247137873,"owners_count":20889945,"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":["approved-public","ember-addon","ember-cli-deploy","ember-cli-deploy-plugin","ghec-mig-migrated","peopledoc-opensource","tribe-js"],"created_at":"2024-12-17T11:15:52.804Z","updated_at":"2025-04-04T07:28:25.684Z","avatar_url":"https://github.com/peopledoc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ember-cli-deploy-index-json\n\n\u003e An Ember CLI Deploy plugin to use a JSON index rather than an HTML one as provided by [`ember-cli-deploy-s3-index`](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index).\n\n[![Build Status](https://travis-ci.org/peopledoc/ember-cli-deploy-index-json.svg?branch=master)](https://travis-ci.org/peopledoc/ember-cli-deploy-index-json)\n\nThis JSON index file is meant to be consumed by some application embedding yours.\n\n```\n$ ember deploy production\n$ cat tmp/deploy-dist/index.json\n{\n  \"assets/dummy.css\": \"assets/dummy-d41d8cd98f00b204e9800998ecf8427e.css\",\n  \"assets/dummy.js\": \"assets/dummy-f1caa4785f44f7dc0ca9118458c120f8.js\",\n  \"assets/vendor.js\": \"assets/vendor-b3a3b580d0c1bf83382792291e35020b.js\",\n  \"assets/vendor.css\": \"assets/vendor-d41d8cd98f00b204e9800998ecf8427e.css\",\n  \"crossdomain.xml\": \"crossdomain.xml\",\n  \"robots.txt\": \"robots.txt\"\n}\n```\n\n## What is an Ember CLI Deploy plugin?\n\nA plugin is an addon that can be executed as a part of the Ember CLI Deploy pipeline. A plugin will implement one or more of the Ember CLI Deploy's pipeline hooks.\n\nFor more information on what plugins are and how they work, please refer to the [Plugin Documentation][1].\n\n## Setup\n\n- Requirements\n\nYou'll first have to [setup `ember-cli-deploy-s3-index`](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index#quick-start).\n\n- Install this plugin\n\n```bash\n$ ember install ember-cli-deploy-index-json\n```\n\n- Configuration\n\nEdit `config/deploy.js` so that your configuration looks like the snippet below.\n\n```js\ns3: {},\n'revision-data': {\n  filePattern: 'index.json'\n},\n's3-index': {\n  filePattern: 'index.json'\n}\n```\n\n_In depth:_ The idea is that `revision-data`, `s3-index` and `index-json` have the same `filePattern` value. `index-json` is not present in this example because we're using its default `filePattern` value.\n\n## Usage\n\n- Deploy version to production environment\n\n`ember deploy production`\n\n- List versions on production environment\n\n`ember deploy:list production`\n\n- Activate a version on the production environment\n\n`ember deploy:activate --revision \u003crevision-key\u003e`\n\n## Ember CLI Deploy Hooks Implemented\n\nFor detailed information on what plugin hooks are and how they work, please refer to the [Plugin Documentation][1].\n\n- `willUpload`\n\n## Configuration Options\n\nFor detailed information on how configuration of plugins works, please refer to the [Plugin Documentation][1].\n\n### filePattern\n\nFiles matching this pattern will be included in the index.\n\n_Default:_ `'**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}'`\n\n### fileIgnorePattern\n\nFiles matching this pattern will _not_ be included in the index even if they match filePattern.\n\n_Default:_ `null`\n\n### indexPath\n\nThe JSON index file name. If changed, you should adapt `revision-data` and `s3-index` plugins configs accordingly.\n\n_Default:_ `'index.json'`\n\n### distDir\n\nDirectory where assets have been written to\n\n_Default:_ the `distDir` property of the deployment context\n\n### distFiles\n\nThe Array of built assets.\n\n_Default:_ the `distFiles` property of the deployment context\n\n## Prerequisites\n\nNo properties are expected to be present on the deployment context object.\n\n## Tests\n\n- yarn test\n\n## Why `ember test` doesn't work\n\nSince this is a node-only Ember CLI addon, we use mocha for testing and this package does not include many files and devDependencies which are part of Ember CLI's typical `ember test` processes.\n\n[1]: http://ember-cli-deploy.com/plugins/ \"Plugin Documentation\"\n[2]: https://github.com/ember-cli-deploy/ember-cli-deploy-build \"ember-cli-deploy-build\"\n\n## Contributors\n\n\u003c!-- readme: contributors,ember-tomster/- -start --\u003e\n\u003ctable\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/GreatWizard\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/1322081?v=4\" width=\"100;\" alt=\"GreatWizard\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eGreatWizard\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/MrChocolatine\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/47531779?v=4\" width=\"100;\" alt=\"MrChocolatine\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eMrChocolatine\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/xcambar\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/657654?v=4\" width=\"100;\" alt=\"xcambar\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003excambar\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/amessinger\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/3007703?v=4\" width=\"100;\" alt=\"amessinger\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eamessinger\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/lifeart\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/1360552?v=4\" width=\"100;\" alt=\"lifeart\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003elifeart\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n        \u003ca href=\"https://github.com/romgere\"\u003e\n            \u003cimg src=\"https://avatars.githubusercontent.com/u/13900970?v=4\" width=\"100;\" alt=\"romgere\"/\u003e\n            \u003cbr /\u003e\n            \u003csub\u003e\u003cb\u003eromgere\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\u003c/tr\u003e\n\u003c/table\u003e\n\u003c!-- readme: contributors,ember-tomster/- -end --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeopledoc%2Fember-cli-deploy-index-json","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeopledoc%2Fember-cli-deploy-index-json","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeopledoc%2Fember-cli-deploy-index-json/lists"}