https://github.com/tiyee/aliyun-oss-auto-upload

upload file or folder to aliyun oss
https://github.com/tiyee/aliyun-oss-auto-upload

actions deployment github-actions oss-upload

Last synced: 26 days ago
JSON representation

upload file or folder to aliyun oss

• Host: GitHub
• URL: https://github.com/tiyee/aliyun-oss-auto-upload
• Owner: tiyee
• License: mit
• Created: 2023-05-28T07:29:27.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-31T13:50:15.000Z (4 months ago)
• Last Synced: 2024-10-08T23:03:52.769Z (about 1 month ago)
• Topics: actions, deployment, github-actions, oss-upload
• Language: TypeScript
• Homepage:
• Size: 3.25 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        


# Aliyun OSS Auto Upload

Easily upload files to Aliyun OSS from GitHub Actions

## Usage

```yaml

steps:

- uses: actions/checkout@master

- uses: tiyee/[email protected]

    with:

      # aliyun config

      region: oss-cn-beijing

      access-key-id: ${{ secrets.ACCESS_KEY_ID }}

      access-key-secret: ${{ secrets.ACCESS_KEY_SECRET }}

      bucket: ${{ secrets.BUCKET }}

      secure: true

      # deploy config

      local-folder: dist # local folder

      remote-dir: /

```

## Arguments

This action supports eight inputs from the user, most of which are required: `region`, `access-key-id`, `access-key-secret`, `bucket`, `secure`, `entry`, `remote-dir`, `path-rewrite`. Their descriptions and default values are listed below:

| Input             | Description                                                                       | Usage    | default      |

| ----------------- | --------------------------------------------------------------------------------- | -------- | ------------ |

| region            | the bucket data region location                                                   | Required |              |

| access-key-id     | access key you create on aliyun console website                                   | Required |              |

| access-key-secret | access secret you create                                                          | Required |              |

| bucket            | the default bucket you want to access If you don't have any bucket, please create | Required |              |

| secure            | instruct OSS client to use HTTPS (secure: true) or HTTP (secure: false) protocol  | Optional | true         |

| local-folder      | You need to upload files of this folder to OSS ,RECURSIVE alse,like `dist/html`                         || |

| remote-dir        | Directory path transferred to OSS                                                 | Optional | \\           |

## Example

```yaml

name: Example workflow for AliyunOSS

on: [push]

jobs:

  Release:

    name: Release

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@master

        with:

          fetch-depth: 2

      - name: Use Node.js 12.x

        uses: actions/setup-node@v1

        with:

          node-version: '12.x'

      - name: Build Project

        run: npm install && npm run build

      - name: Deploy OSS

        uses: tiyee/[email protected]

        with:

          # aliyun config

          region: oss-cn-beijing

          access-key-id: ${{ secrets.ACCESS_KEY_ID }}

          access-key-secret: ${{ secrets.ACCESS_KEY_SECRET }}

          bucket: ${{ secrets.BUCKET }}

          secure: true

          # deploy config

          local-folder: dist

          remote-dir: /

```