Skip to content

docs: the CLI command is 'translate forward --github' #127

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
mmcky merged 1 commit into from
Jul 21, 2026
Merged

docs: the CLI command is 'translate forward --github' #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion dist-action/index.js.map
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions examples/rebase-translations.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# When a translation PR is merged, this workflow automatically rebases the
# other open translation PRs against the updated main branch. It covers both
# kinds this tool creates: `translation-sync-*` branches from the Action's sync
# mode, and `resync/*` branches from the CLI's `forward --github`.
# mode, and `resync/*` branches from the CLI's `translate forward --github`.
#
# This eliminates merge conflicts caused by multiple upstream PRs
# modifying the same files. See: https://github.com/QuantEcon/action-translation/issues/63
Expand All @@ -20,7 +20,7 @@ on:
jobs:
rebase:
# Only run when a translation PR is merged. Both prefixes must be listed:
# sync mode creates `translation-sync-*`, while the CLI's `forward --github`
# sync mode creates `translation-sync-*`, while the CLI's `translate forward --github`
# creates `resync/*`, and a wave of resync PRs goes stale the same way.
# Keep this in step with `isTranslationBranch` in the action's src/branch-naming.ts
# — this `if` decides whether the job runs, that predicate decides which open PRs
Expand Down
4 changes: 2 additions & 2 deletions src/branch-naming.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
*
* - the GitHub Action's sync mode creates `translation-sync-{timestamp}-pr-{n}`
* (see `createTranslationPR` in pr-creator.ts)
* - the CLI's `forward --github` creates `resync/{stem}`
* - the CLI's `translate forward --github` creates `resync/{stem}`
* (see `buildBranchName` in cli/forward-pr-creator.ts)
*
* Rebase mode has to recognise **both**, because a wave of resync PRs goes stale
Expand All @@ -24,7 +24,7 @@
/** Branch prefix used by the Action's sync mode. */
export const SYNC_BRANCH_PREFIX = 'translation-sync-';

/** Branch prefix used by the CLI's `forward --github` resync mode. */
/** Branch prefix used by the CLI's `translate forward --github` resync mode. */
export const RESYNC_BRANCH_PREFIX = 'resync/';

/** Every branch prefix that identifies a translation PR this tool created. */
Expand Down
Loading