funguy/setup-ossutil
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Rimo
2020-01-15 18:39:15 +08:00
committed by GitHub
parent 0c8863c173
commit ce32415cd7
1 changed files with 19 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
README.md
View File

@@ -1,117 +1,30 @@
<p align="center"> # setup-ossutil
<a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
</p>
# Create a JavaScript Action using TypeScript [![GitHub Actions status](https://github.com/yizhoumo/setup-ossutil/workflows/build-test/badge.svg)](https://github.com/yizhoumo/setup-ossutil/actions)
Use this template to bootstrap the creation of a JavaScript action.:rocket: This action sets up [Alibaba Cloud OSSUTIL](https://github.com/aliyun/ossutil) for use in actions by:
This template includes compilication support, tests, a validation workflow, publishing, and versioning guidance. - downloading and caching ossutil by version and adding to PATH
- configuring ossutil with your credentials
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) ## Usage
## Create an action from this template See [action.yml](action.yml)
Click the `Use this Template` and provide the new repo details for your action
## Code in Master
Install the dependencies
```bash
$ npm install
```
Build the typescript
```bash
$ npm run build
```
Run the tests :heavy_check_mark:
```bash
$ npm test
PASS ./index.test.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
...
```
## Change action.yml
The action.yml contains defines the inputs and output for your action.
Update the action.yml with your name, description, inputs and outputs for your action.
See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
## Change the Code
Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
```javascript
import * as core from '@actions/core';
...
async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}
run()
```
See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
## Publish to a distribution branch
Actions are run from GitHub repos. We will create a releases branch and only checkin production modules (core in this case).
Comment out node_modules in .gitignore and create a releases/v1 branch
```bash
# comment out in distribution branches
# node_modules/
```
```bash
$ git checkout -b releases/v1
$ git commit -a -m "prod dependencies"
```
```bash
$ npm prune --production
$ git add node_modules
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```
Your action is now published! :rocket:
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
## Validate
You can now validate the action by referencing the releases/v1 branch
```yaml ```yaml
uses: actions/typescript-action@releases/v1 steps:
with: - uses: actions/checkout@v1
milliseconds: 1000 - uses: yizhoumo/setup-ossutil@v1
with:
ossutil-version: '1.6.10' # Optional
endpoint: ${{ secrets.OSS_ENDPOINT }}
access-key-id: ${{ secrets.OSS_ACCESS_KEY_ID }}
access-key-secret: ${{ secrets.OSS_ACCESS_KEY_SECRET }}
- run: ossutil cp -f file-to-upload.txt oss://your-bucket/path
``` ```
See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket: See also: [Document of ossutil](https://help.aliyun.com/document_detail/50452.html)
## Usage: ## License
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and tested action The scripts and documentation in this project are released under the [MIT License](LICENSE)
```yaml
uses: actions/typescript-action@v1
with:
milliseconds: 1000
```