{"id":21708510,"url":"https://github.com/ufologist/gulp-oss-upload","last_synced_at":"2025-04-12T16:30:23.053Z","repository":{"id":57258413,"uuid":"65701742","full_name":"ufologist/gulp-oss-upload","owner":"ufologist","description":"A gulp plugin for uploading static file to aliyun oss(by official ali-oss sdk).","archived":false,"fork":false,"pushed_at":"2016-08-17T00:48:26.000Z","size":27,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-26T10:52:19.650Z","etag":null,"topics":["aliyun-oss"],"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/ufologist.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":"2016-08-15T03:28:36.000Z","updated_at":"2020-05-01T07:36:55.000Z","dependencies_parsed_at":"2022-08-25T21:22:46.941Z","dependency_job_id":null,"html_url":"https://github.com/ufologist/gulp-oss-upload","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/ufologist%2Fgulp-oss-upload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ufologist%2Fgulp-oss-upload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ufologist%2Fgulp-oss-upload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ufologist%2Fgulp-oss-upload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ufologist","download_url":"https://codeload.github.com/ufologist/gulp-oss-upload/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248144006,"owners_count":21054862,"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":["aliyun-oss"],"created_at":"2024-11-25T22:27:20.469Z","updated_at":"2025-04-12T16:30:23.032Z","avatar_url":"https://github.com/ufologist.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gulp-oss-upload\r\n\r\n[![NPM version][npm-image]][npm-url]\r\n\r\n[npm-image]: https://img.shields.io/npm/v/gulp-oss-upload.svg?style=flat-square\r\n[npm-url]: https://npmjs.org/package/gulp-oss-upload\r\n\r\nA gulp plugin for uploading static file to aliyun oss(by official [ali-oss sdk](https://github.com/ali-sdk/ali-oss)).\r\n\r\n上传文件到阿里云 OSS 的 gulp 插件.\r\n\r\n## install\r\n`npm install gulp-oss-upload --save-dev`\r\n\r\n## usage\r\n```javascript\r\nvar gulp = require('gulp');\r\nvar ossUpload = require('gulp-oss-upload');\r\n\r\ngulp.task('publish-oss', function() {\r\n    return gulp.src('./app.js')\r\n               .pipe(ossUpload({\r\n                    accessKeyId: 'your accessKeyId',\r\n                    accessKeySecret: 'your accessKeySecret',\r\n                    bucket: 'your bucket name',\r\n                    region: 'oss-cn-hangzhou', // the bucket data region location, default is oss-cn-hangzhou\r\n                    rootDir: 'v1' // upload file root directory in the bucket(optional)\r\n                }));\r\n});\r\n```\r\n\r\nThis config will upload your current directory file `app.js` to `v1/app.js` in your bucket.\r\n\r\nRequired param details please view [oss(options)](https://github.com/ali-sdk/ali-oss#ossoptions)\r\n\r\n## optional param\r\n\r\n### rootDir {string}\r\n`default: ''; //root directory`\r\n\r\n### customObjectName {function}\r\n```javascript\r\n/**\r\n * custom object name\r\n * \r\n * @param objectName {string} default generate objectName\r\n * @param rootDir {string} options.rootDir\r\n * @param fileRelative {string} the file path relative to cwd path\r\n *\r\n * @return {string}\r\n */\r\nfunction(objectName, rootDir, fileRelative) {\r\n\treturn '';\r\n}\r\n```\r\n\r\n## reference\r\n* [gulp-oss-up](https://github.com/marshalYuan/gulp-oss-up)\r\n\r\n  功能完全正常, 满足了我的需求(感谢作者), 但使用过程中发现 OSS SDK 不是阿里云官方的 SDK. `objectDir` 配置项也有点 [bug](https://github.com/marshalYuan/gulp-oss-up/issues/1), 因此自己参考着重写了一个.\r\n  \r\n## one more thing\r\n* [静态资源自动化发布方案](https://github.com/ufologist/gulp-oss-upload/blob/master/static-file-auto-deploy.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fufologist%2Fgulp-oss-upload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fufologist%2Fgulp-oss-upload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fufologist%2Fgulp-oss-upload/lists"}