Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shangzhenyang/upyun-uploader
The command-line interface for uploading the selected directory to UPYUN Storage Service.
https://github.com/shangzhenyang/upyun-uploader
cicd gitlab storage uploader upyun
Last synced: 11 days ago
JSON representation
The command-line interface for uploading the selected directory to UPYUN Storage Service.
- Host: GitHub
- URL: https://github.com/shangzhenyang/upyun-uploader
- Owner: shangzhenyang
- License: mit
- Created: 2024-01-18T03:26:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-12T18:43:27.000Z (11 months ago)
- Last Synced: 2024-04-14T08:52:43.563Z (10 months ago)
- Topics: cicd, gitlab, storage, uploader, upyun
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@shangzhen/upyun-uploader
- Size: 122 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UPYUN Uploader
The command-line interface for uploading the selected directory to UPYUN Storage Service. This tool is particularly useful in continuous integration and continuous deployment (CI/CD) workflows, such as with GitLab Pipelines.
The content in the bucket will be completely replaced by the content in the selected directory. Any files present in the bucket but not in the local directory will be deleted.
## Installation
Install UPYUN Uploader globally using npm with the following command:
```bash
npm install -g upyun-uploader
```
## Configuration
Set up your UPYUN operator and password as environment variables:
```bash
export UPYUN_OPERATOR=
export UPYUN_PASSWORD=
```
Refer to [UPYUN's documentation](https://docs.upyun.com/guide/) for details on obtaining these credentials.
## Usage
To upload a directory to a UPYUN bucket, use the following command:
```bash
upyun-uploader
```
Replace `` with your UPYUN bucket name and `` with the path to the directory you wish to upload.
## Integration with GitLab CI/CD
To integrate UPYUN Uploader with GitLab CI/CD, add the following configuration to your `.gitlab-ci.yml` file:
```yaml
deploy:
stage: deploy
image: node:20-slim
script:
- npm install -g upyun-uploader
- upyun-uploader
only:
- main
```
Replace the content in `<...>` with your own information.
If your main branch is not named `main`, you need to change it in the `only` section.
Remember to set `UPYUN_OPERATOR` and `UPYUN_PASSWORD` as environment variables in your GitLab project settings.
## License
[MIT](LICENSE).