/issues-translate-action

The action for translating Non-English issues content to English.

Primary LanguageTypeScriptMIT LicenseMIT

Issues Translate Action

The action for translating Non-English issues content to English.

中文文档

Usage

Use the default bot account @Issues-translate-bot

Create a workflow from this action

Create file issue-translator.yml in .github/workflows/

name: 'issue-translator'
on: 
  issue_comment: 
    types: [created]
  issues: 
    types: [opened]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: usthe/issues-translate-action@v2.7
        with:
          IS_MODIFY_TITLE: false
          # not require, default false, . Decide whether to modify the issue title
          # if true, the robot account @Issues-translate-bot must have modification permissions, invite @Issues-translate-bot to your project or use your custom bot.
          CUSTOM_BOT_NOTE: Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿
          # not require. Customize the translation robot prefix message.

Advanced Custom

Use your own bot by add BOT_GITHUB_TOKEN

  1. Create a new github account as your bot

  2. Use the account to generate a new token as BOT_GITHUB_TOKEN

  3. Add the Secrets BOT_GITHUB_TOKEN = ${token} in your project

  4. Create a workflow from this action(Create file issue-translator.yml in .github/workflows/)

name: 'issue-translator'
on: 
  issue_comment: 
    types: [created]
  issues: 
    types: [opened]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: usthe/issues-translate-action@v2.7
        with:
          BOT_GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN }} 
          # Required, input your bot github token
          BOT_LOGIN_NAME: Issues-translate-bot    
          # Not required, suggest not input, action will get name from BOT_GITHUB_TOKEN
          # If input, BOT name must match github token

Other

  1. invite @Issues-translate-bot to your project.
    Project -> Settings -> Manage access -> Invite a collaborator
    Post an issue in issues-translate-action to let us know, the @Issues-translate-bot will join soon.

DEMO

action-sample

Who Use the Action?

  1. hertzbeat Create By Us - A real-time monitoring system with custom-monitor and agentless.
  2. sureness Create By Us - A simple and efficient security framework that focus on protection of API.
  3. go-zero - A cloud-native Go microservices framework with cli tool for productivity.
  4. dashy - A self-hostable personal dashboard built for you.
  5. wails - Create beautiful applications using Go
  6. seata-go - Go Implementation For Seata
  7. rainbond - Cloud native multi cloud application management platform
  8. adempiere - ADempiere Business Suite done the Bazaar way in an open and unabated fashion.
  9. carbon - A simple, semantic and developer-friendly golang package for datetime
  10. tabby - A terminal for a more modern age
  11. gorse - An open source recommender system service written in Go

Have Fun!

Contributors ✨

tomsun28
tomsun28

💻 🖋
All Contributors
All Contributors

📖
chen quan
chen quan

💻