Skip to content

Docs: Add 6-hour time limit warning under 'Running the Workflow' section #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 8, 2025
Merged

Docs: Add 6-hour time limit warning under 'Running the Workflow' section #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a5779d
Docs: Add 6-hour time limit warning under 'Running the Workflow' section
skytin1004 Aug 8, 2025
5502bdb
Docs: Add 6-hour time limit warning under 'Running the Workflow' section
skytin1004 Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions getting_started/github-actions-guide/github-actions-guide-org.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,14 @@ jobs:

## Running the Workflow

> [!WARNING]
> **GitHub-hosted Runner Time Limit:**
> GitHub-hosted runners such as `ubuntu-latest` have a **maximum execution time limit of 6 hours**.
> For large documentation repositories, if the translation process exceeds 6 hours, the workflow will be automatically terminated.
> To prevent this, consider:
> - Using a **self-hosted runner** (no time limit)
> - Reducing the number of target languages per run

Once the `co-op-translator.yml` file is merged into your main branch (or the branch specified in the `on:` trigger), the workflow will automatically run whenever changes are pushed to that branch (and match the `paths` filter, if configured).

If translations are generated or updated, the action will automatically create a Pull Request containing the changes, ready for your review and merging.
14 changes: 13 additions & 1 deletion getting_started/github-actions-guide/github-actions-guide-public.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,4 +162,16 @@ jobs:
4. **Customize the Workflow:**
- **[!IMPORTANT] Target Languages:** In the `Run Co-op Translator` step, you **MUST review and modify the list of language codes** within the `translate -l "..." -y` command to match your project's requirements. The example list (`ar de es...`) needs to be replaced or adjusted.
- **Trigger (`on:`):** The current trigger runs on every push to `main`. For large repositories, consider adding a `paths:` filter (see commented example in the YAML) to run the workflow only when relevant files (e.g., source documentation) change, saving runner minutes.
- **PR Details:** Customize the `commit-message`, `title`, `body`, `branch` name, and `labels` in the `Create Pull Request` step if needed.
- **PR Details:** Customize the `commit-message`, `title`, `body`, `branch` name, and `labels` in the `Create Pull Request` step if needed.

## Running the Workflow

> [!WARNING]
> **GitHub-hosted Runner Time Limit:**
> GitHub-hosted runners such as `ubuntu-latest` have a **maximum execution time limit of 6 hours**.
> For large documentation repositories, if the translation process exceeds 6 hours, the workflow will be automatically terminated.
> To prevent this, consider:
> - Using a **self-hosted runner** (no time limit)
> - Reducing the number of target languages per run

Once the `co-op-translator.yml` file is merged into your main branch (or the branch specified in the `on:` trigger), the workflow will automatically run whenever changes are pushed to that branch (and match the `paths` filter, if configured).