更新readme

This commit is contained in:
Easy
2023-02-04 17:47:32 +08:00
parent 0467e78c9e
commit 60bd69bd20
2 changed files with 17 additions and 100 deletions

117
README.md
View File

@@ -1,107 +1,24 @@
> ⚠️ 测试中,暂勿使用
# Server酱微信推送 GitHub Action
<p align="center">
<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
Use this template to bootstrap the creation of a TypeScript action.:rocket:
## 使用方法
This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.
1. 将 sendkey 添加到仓库的 Actions secrets 中,命名为 sendkey
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
![](images/20230204173837.png)
## Create an action from this template
2. 在 workflow 中使用,例子如下:
Click the `Use this Template` and provide the new repo details for your action
## Code in Main
> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
Install the dependencies
```bash
$ npm install
```
Build the typescript and package it for distribution
```bash
$ npm run build && npm run package
```
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 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 so we will checkin the packed dist folder.
Then run [ncc](https://github.com/zeit/ncc) and push the results:
```bash
$ npm run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```
Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
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 `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
```yaml
uses: ./
with:
milliseconds: 1000
```
See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
## Usage:
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action
```yml
- uses: josStorer/get-current-time@v2.0.2
id: current-time
with:
format: YYYYMMDD-HH
utcOffset: "+08:00"
- uses: easychen/github-action-server-chan@v1
with:
sendkey: ${{ secrets.sendkey }}
title: "server酱Action更新啦 ${{ steps.current-time.outputs.formattedTime }}"
desp: "可以为空。支持Markdown"
```

BIN
images/20230204173837.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB