refactor: 重构GitHub Action为OBS上传工作流

README.md

@@ -1,263 +1,123 @@
-# Create a GitHub Action Using TypeScript
+# Upload to OBS
 
-[![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
-![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg)
-[![Check dist/](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
-[![CodeQL](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
-[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)
+这是一个用于将本地包上传到OBS（Open Build Service）的GitHub Actions工作流。
 
-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.
+- Elysia
 
-If you are new, there's also a simpler introduction in the
-[Hello world JavaScript action repository](https://github.com/actions/hello-world-javascript-action).
+## 功能
 
-## Create Your Own Action
+该工作流允许您将本地包上传到OBS。它支持配置各种参数，如是否移除旧的源文件、OBS包名、项目名、用户名、密码、实例URL和本地包目录。
 
-To create your own action, you can use this repository as a template! Just
-follow the below instructions:
+## 配置
 
-1. Click the **Use this template** button at the top of the repository
-1. Select **Create a new repository**
-1. Select an owner and name for your new repository
-1. Click **Create repository**
-1. Clone your new repository
+### 标识
 
-> [!IMPORTANT]
->
-> Make sure to remove or update the [`CODEOWNERS`](./CODEOWNERS) file! For
-> details on how to use this file, see
-> [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
+- 图标: `heart`
+- 颜色: `red`
 
-## Initial Setup
+### 输入参数
 
-After you've cloned the repository to your local machine or codespace, you'll
-need to perform some initial setup steps before you can develop your action.
+#### `remove-old-sources`
 
-> [!NOTE]
->
-> You'll need to have a reasonably modern version of
-> [Node.js](https://nodejs.org) handy (20.x or later should work!). If you are
-> using a version manager like [`nodenv`](https://github.com/nodenv/nodenv) or
-> [`fnm`](https://github.com/Schniz/fnm), this template has a `.node-version`
-> file at the root of the repository that can be used to automatically switch to
-> the correct version when you `cd` into the repository. Additionally, this
-> `.node-version` file is used by GitHub Actions in any `actions/setup-node`
-> actions.
+- **描述**: 是否从OBS包中移除旧的源文件。
+- **类型**: Boolean
+- **必需**: 是
+- **默认值**: `true`
 
-1. :hammer_and_wrench: Install the dependencies
+#### `obs-package-name`
 
-   ```bash
-   npm install
-   ```
+- **描述**: OBS包的名称。
+- **类型**: String
+- **必需**: 是
 
-1. :building_construction: Package the TypeScript for distribution
+#### `obs-project-name`
 
-   ```bash
-   npm run bundle
-   ```
+- **描述**: OBS项目的名称。
+- **类型**: String
+- **必需**: 是
 
-1. :white_check_mark: Run the tests
+#### `obs-user-name`
 
-   ```bash
-   $ npm test
+- **描述**: OBS的用户名。
+- **类型**: String
+- **必需**: 是
 
-   PASS  ./index.test.js
-     ✓ throws invalid number (3ms)
-     ✓ wait 500 ms (504ms)
-     ✓ test runs (95ms)
+#### `obs-password`
 
-   ...
-   ```
+- **描述**: OBS的密码。
+- **类型**: String
+- **必需**: 是
 
-## Update the Action Metadata
+#### `obs-instance-url`
 
-The [`action.yml`](action.yml) file defines metadata about your action, such as
-input(s) and output(s). For details about this file, see
-[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions).
+- **描述**: OBS实例的URL。
+- **类型**: String
+- **必需**: 是
+- **默认值**: `https://api.opensuse.org`
 
-When you copy this repository, update `action.yml` with the name, description,
-inputs, and outputs for your action.
+#### `local-package-dir`
 
-## Update the Action Code
+- **描述**: 本地包的目录。
+- **类型**: String
+- **必需**: 是
 
-The [`src/`](./src/) directory is the heart of your action! This contains the
-source code that will be run when your action is invoked. You can replace the
-contents of this directory with your own code.
+## 使用方法
 
-There are a few things to keep in mind when writing your action code:
-
-- Most GitHub Actions toolkit and CI/CD operations are processed asynchronously.
-  In `main.ts`, you will see that 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)
-    }
-  }
-  ```
-
-  For more information about the GitHub Actions toolkit, see the
-  [documentation](https://github.com/actions/toolkit/blob/master/README.md).
-
-So, what are you waiting for? Go ahead and start customizing your action!
-
-1. Create a new branch
-
-   ```bash
-   git checkout -b releases/v1
-   ```
-
-1. Replace the contents of `src/` with your action code
-1. Add tests to `__tests__/` for your source code
-1. Format, test, and build the action
-
-   ```bash
-   npm run all
-   ```
-
-   > This step is important! It will run [`ncc`](https://github.com/vercel/ncc)
-   > to build the final JavaScript action code with all dependencies included.
-   > If you do not run this step, your action will not work correctly when it is
-   > used in a workflow. This step also includes the `--license` option for
-   > `ncc`, which will create a license file for all of the production node
-   > modules used in your project.
-
-1. (Optional) Test your action locally
-
-   The [`@github/local-action`](https://github.com/github/local-action) utility
-   can be used to test your action locally. It is a simple command-line tool
-   that "stubs" (or simulates) the GitHub Actions Toolkit. This way, you can run
-   your TypeScript action locally without having to commit and push your changes
-   to a repository.
-
-   The `local-action` utility can be run in the following ways:
-
-   - Visual Studio Code Debugger
-
-     Make sure to review and, if needed, update
-     [`.vscode/launch.json`](./.vscode/launch.json)
-
-   - Terminal/Command Prompt
-
-     ```bash
-     # npx local action <action-yaml-path> <entrypoint> <dotenv-file>
-     npx local-action . src/main.ts .env
-     ```
-
-   You can provide a `.env` file to the `local-action` CLI to set environment
-   variables used by the GitHub Actions Toolkit. For example, setting inputs and
-   event payload data used by your action. For more information, see the example
-   file, [`.env.example`](./.env.example), and the
-   [GitHub Actions Documentation](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).
-
-1. Commit your changes
-
-   ```bash
-   git add .
-   git commit -m "My first action is ready!"
-   ```
-
-1. Push them to your repository
-
-   ```bash
-   git push -u origin releases/v1
-   ```
-
-1. Create a pull request and get feedback on your action
-1. Merge the pull request into the `main` branch
-
-Your action is now published! :rocket:
-
-For information about versioning your action, see
-[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-in the GitHub Actions toolkit.
-
-## Validate the Action
-
-You can now validate the action by referencing it in a workflow file. For
-example, [`ci.yml`](./.github/workflows/ci.yml) demonstrates how to reference an
-action in the same repository.
+1. 在您的GitHub仓库中创建一个`.github/workflows`目录（如果尚未创建）。
+2. 在该目录中创建一个新的YAML文件，例如`upload-to-obs.yml`。
+3. 将以下内容复制到新创建的YAML文件中：
 
 ```yaml
-steps:
-  - name: Checkout
-    id: checkout
-    uses: actions/checkout@v4
-
-  - name: Test Local Action
-    id: test-action
-    uses: ./
-    with:
-      milliseconds: 1000
-
-  - name: Print Output
-    id: output
-    run: echo "${{ steps.test-action.outputs.time }}"
+name: 'Upload to OBS'
+description: 'Upload to OBS'
+author: 'Elysia'
+
+# Add your action's branding here. This will appear on the GitHub Marketplace.
+branding:
+  icon: 'heart'
+  color: 'red'
+
+# Define your inputs here.
+inputs:
+  remove-old-sources:
+    description: 'Remove old sources from OBS package'
+    required: true
+    default: true
+  obs-package-name:
+    description: 'OBS package name'
+    required: true
+  obs-project-name:
+    description: 'OBS project name'
+    required: true
+  obs-user-name:
+    description: 'OBS user name'
+    required: true
+  obs-password:
+    description: 'OBS password'
+    required: true
+  obs-instance-url:
+    description: 'OBS instance URL'
+    required: true
+    default: 'https://api.opensuse.org'
+  local-package-dir:
+    description: 'Local package directory'
+    required: true
 ```
 
-For example workflow runs, check out the
-[Actions tab](https://github.com/actions/typescript-action/actions)! :rocket:
+4. 根据您的需求修改输入参数的值。
+5. 提交并推送更改到您的GitHub仓库。
 
-## Usage
+## 注意事项
 
-After testing, you can create version tag(s) that developers can use to
-reference different stable versions of your action. For more information, see
-[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-in the GitHub Actions toolkit.
+- 请确保您的GitHub仓库具有访问OBS实例的权限。
+- 确保本地包目录中包含有效的包文件。
 
-To include the action in a workflow in another repository, you can use the
-`uses` syntax with the `@` symbol to reference a specific branch, tag, or commit
-hash.
+## 贡献
 
-```yaml
-steps:
-  - name: Checkout
-    id: checkout
-    uses: actions/checkout@v4
-
-  - name: Test Local Action
-    id: test-action
-    uses: actions/typescript-action@v1 # Commit with the `v1` tag
-    with:
-      milliseconds: 1000
-
-  - name: Print Output
-    id: output
-    run: echo "${{ steps.test-action.outputs.time }}"
-```
+如果您有任何改进意见或想要贡献代码，请随时提交Pull Request或创建Issue。
+
+## 许可证
 
-## Publishing a New Release
-
-This project includes a helper script, [`script/release`](./script/release)
-designed to streamline the process of tagging and pushing new releases for
-GitHub Actions.
-
-GitHub Actions allows users to select a specific version of the action to use,
-based on release tags. This script simplifies this process by performing the
-following steps:
-
-1. **Retrieving the latest release tag:** The script starts by fetching the most
-   recent SemVer release tag of the current branch, by looking at the local data
-   available in your repository.
-1. **Prompting for a new release tag:** The user is then prompted to enter a new
-   release tag. To assist with this, the script displays the tag retrieved in
-   the previous step, and validates the format of the inputted tag (vX.X.X). The
-   user is also reminded to update the version field in package.json.
-1. **Tagging the new release:** The script then tags a new release and syncs the
-   separate major tag (e.g. v1, v2) with the new release tag (e.g. v1.0.0,
-   v2.1.2). When the user is creating a new major release, the script
-   auto-detects this and creates a `releases/v#` branch for the previous major
-   version.
-1. **Pushing changes to remote:** Finally, the script pushes the necessary
-   commits, tags and branches to the remote repository. From here, you will need
-   to create a new release in GitHub so users can easily reference the new tags
-   in their workflows.
+该工作流遵循MIT许可证。请查看LICENSE文件了解更多信息。

action.yml

@@ -33,11 +33,6 @@ inputs:
     description: 'Local package directory'
     required: true
 
-# Define your outputs here.
-outputs:
-  time:
-    description: 'Your output description here'
-
 runs:
   using: node20
   main: dist/index.js