siliconflow/hf-to-oss

siliconflow/hf-to-oss

Language: TypeScript

License: MIT

Stars: 0

Forks: 0

Open issues: 4

Created: 2024-07-01T07:27:00Z

Pushed: 2024-10-14T04:47:56Z

Default branch: main

Fork: no

Archived: no

README:

Sync HF Repository to OSS

Development

GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/J5Tsai/debug-static-file

Create a GitHub Action Using TypeScript

 !CI   [](./badges/coverage.svg)

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.

If you are new, there's also a simpler introduction in the Hello world JavaScript action repository.

Create Your Own Action

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.

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.

> [!NOTE] > > You'll need to have a reasonably modern version of > Node.js handy (20.x or later should work!). If you are > using a version manager like `nodenv` or > `nvm`, this template has a .node-version > file at the root of the repository that will 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.

1. :hammer_and_wrench: Install the dependencies

npm install

1. :building_construction: Package the TypeScript for distribution

npm run bundle

1. :white_check_mark: Run the tests

$ npm test

PASS ./index.test.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)

...

Update the Action Metadata

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.

When you copy this repository, update action.yml with the name, description, inputs, and outputs for your action.

Update the Action Code

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.

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.

So, what are you waiting for? Go ahead and start customizing your action!

1. Create a new branch

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

npm run all

> This step is important! It will run `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. Commit your changes

git add .
git commit -m "My first action is ready!"

1. Push them to your repository

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 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.

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 }}"

For example workflow runs, check out the Actions tab! :rocket:

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 in the GitHub Actions toolkit.

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.…