docs(cli): rename rollback docs to pin
- commit
- 9dd6453cf0ff17afea069f3a81c34701c07a9bef
- author
- brice · · 2026-04-28 02:59 UTC
- parent
- 07567de
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
2 files · +68 -60
A docs/cli/pin.md +68 -0
| @@ -0,0 +1,68 @@ | |||
| 1 | + | # Pin Command | |
| 2 | + | ||
| 3 | + | Pin a route to a specific image tag. | |
| 4 | + | ||
| 5 | + | ## gordon pin | |
| 6 | + | ||
| 7 | + | ### Synopsis | |
| 8 | + | ||
| 9 | + | ```bash | |
| 10 | + | gordon pin <domain> [options] | |
| 11 | + | gordon pin list <domain> | |
| 12 | + | ``` | |
| 13 | + | ||
| 14 | + | ### Arguments | |
| 15 | + | ||
| 16 | + | | Argument | Description | | |
| 17 | + | |----------|-------------| | |
| 18 | + | | `<domain>` | The route domain to pin | | |
| 19 | + | ||
| 20 | + | ### Options | |
| 21 | + | ||
| 22 | + | | Option | Description | | |
| 23 | + | |--------|-------------| | |
| 24 | + | | `--tag` | Target tag (skips interactive selection) | | |
| 25 | + | | `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) | | |
| 26 | + | | `--token` | Authentication token for remote | | |
| 27 | + | ||
| 28 | + | ### Description | |
| 29 | + | ||
| 30 | + | `gordon pin` deploys a selected image tag for the given route. Tags are | |
| 31 | + | listed from the Gordon registry, with semver tags sorted in descending | |
| 32 | + | order first, followed by non-semver tags. | |
| 33 | + | ||
| 34 | + | Use cases: | |
| 35 | + | - **Rollback** — revert to a previous stable version | |
| 36 | + | - **Forward** — advance to a newer version | |
| 37 | + | - **Lock** — pin to a specific version instead of following `latest` | |
| 38 | + | - **Test** — switch to an experimental tag | |
| 39 | + | ||
| 40 | + | `gordon pin list <domain>` lists available tags without deploying and | |
| 41 | + | marks the current tag. | |
| 42 | + | ||
| 43 | + | If the selected tag matches the current running tag, no action is taken. | |
| 44 | + | ||
| 45 | + | ### Examples | |
| 46 | + | ||
| 47 | + | ```bash | |
| 48 | + | # Interactive selection | |
| 49 | + | gordon pin myapp.example.com | |
| 50 | + | ||
| 51 | + | # Pin to a specific tag | |
| 52 | + | gordon pin myapp.example.com --tag v1.2.0 | |
| 53 | + | ||
| 54 | + | # List available tags for a domain | |
| 55 | + | gordon pin list myapp.example.com | |
| 56 | + | ``` | |
| 57 | + | ||
| 58 | + | ### Notes | |
| 59 | + | ||
| 60 | + | - Remote mode required. See [CLI Overview](./index.md) for targeting options. | |
| 61 | + | - Tags are read from the Gordon registry configured on the server. | |
| 62 | + | ||
| 63 | + | ## Related | |
| 64 | + | ||
| 65 | + | - [CLI Overview](./index.md) | |
| 66 | + | - [Push Command](./push.md) | |
| 67 | + | - [Routes Command](./routes.md) | |
| 68 | + | - [Deployment Rollback Strategies](../deployment/rollback.md) | |
| @@ -0,0 +1,68 @@ | |||||
| 1 | + | # Pin Command | |||
| 2 | + | ||||
| 3 | + | Pin a route to a specific image tag. | |||
| 4 | + | ||||
| 5 | + | ## gordon pin | |||
| 6 | + | ||||
| 7 | + | ### Synopsis | |||
| 8 | + | ||||
| 9 | + | ```bash | |||
| 10 | + | gordon pin <domain> [options] | |||
| 11 | + | gordon pin list <domain> | |||
| 12 | + | ``` | |||
| 13 | + | ||||
| 14 | + | ### Arguments | |||
| 15 | + | ||||
| 16 | + | | Argument | Description | | |||
| 17 | + | |----------|-------------| | |||
| 18 | + | | `<domain>` | The route domain to pin | | |||
| 19 | + | ||||
| 20 | + | ### Options | |||
| 21 | + | ||||
| 22 | + | | Option | Description | | |||
| 23 | + | |--------|-------------| | |||
| 24 | + | | `--tag` | Target tag (skips interactive selection) | | |||
| 25 | + | | `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) | | |||
| 26 | + | | `--token` | Authentication token for remote | | |||
| 27 | + | ||||
| 28 | + | ### Description | |||
| 29 | + | ||||
| 30 | + | `gordon pin` deploys a selected image tag for the given route. Tags are | |||
| 31 | + | listed from the Gordon registry, with semver tags sorted in descending | |||
| 32 | + | order first, followed by non-semver tags. | |||
| 33 | + | ||||
| 34 | + | Use cases: | |||
| 35 | + | - **Rollback** — revert to a previous stable version | |||
| 36 | + | - **Forward** — advance to a newer version | |||
| 37 | + | - **Lock** — pin to a specific version instead of following `latest` | |||
| 38 | + | - **Test** — switch to an experimental tag | |||
| 39 | + | ||||
| 40 | + | `gordon pin list <domain>` lists available tags without deploying and | |||
| 41 | + | marks the current tag. | |||
| 42 | + | ||||
| 43 | + | If the selected tag matches the current running tag, no action is taken. | |||
| 44 | + | ||||
| 45 | + | ### Examples | |||
| 46 | + | ||||
| 47 | + | ```bash | |||
| 48 | + | # Interactive selection | |||
| 49 | + | gordon pin myapp.example.com | |||
| 50 | + | ||||
| 51 | + | # Pin to a specific tag | |||
| 52 | + | gordon pin myapp.example.com --tag v1.2.0 | |||
| 53 | + | ||||
| 54 | + | # List available tags for a domain | |||
| 55 | + | gordon pin list myapp.example.com | |||
| 56 | + | ``` | |||
| 57 | + | ||||
| 58 | + | ### Notes | |||
| 59 | + | ||||
| 60 | + | - Remote mode required. See [CLI Overview](./index.md) for targeting options. | |||
| 61 | + | - Tags are read from the Gordon registry configured on the server. | |||
| 62 | + | ||||
| 63 | + | ## Related | |||
| 64 | + | ||||
| 65 | + | - [CLI Overview](./index.md) | |||
| 66 | + | - [Push Command](./push.md) | |||
| 67 | + | - [Routes Command](./routes.md) | |||
| 68 | + | - [Deployment Rollback Strategies](../deployment/rollback.md) | |||
D docs/cli/rollback.md +0 -60
| @@ -1,60 +0,0 @@ | |||
| 1 | - | # Rollback Command | |
| 2 | - | ||
| 3 | - | Roll back a route to a previous image tag. | |
| 4 | - | ||
| 5 | - | ## gordon rollback | |
| 6 | - | ||
| 7 | - | ### Synopsis | |
| 8 | - | ||
| 9 | - | ```bash | |
| 10 | - | gordon rollback <domain> [options] | |
| 11 | - | gordon rollback list <domain> | |
| 12 | - | ``` | |
| 13 | - | ||
| 14 | - | ### Arguments | |
| 15 | - | ||
| 16 | - | | Argument | Description | | |
| 17 | - | |----------|-------------| | |
| 18 | - | | `<domain>` | The route domain to roll back | | |
| 19 | - | ||
| 20 | - | ### Options | |
| 21 | - | ||
| 22 | - | | Option | Description | | |
| 23 | - | |--------|-------------| | |
| 24 | - | | `--tag` | Target tag (skips interactive selection) | | |
| 25 | - | | `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) | | |
| 26 | - | | `--token` | Authentication token for remote | | |
| 27 | - | ||
| 28 | - | ### Description | |
| 29 | - | ||
| 30 | - | `gordon rollback` deploys a selected tag for the route's repository. | |
| 31 | - | Semver tags are sorted in descending order first, followed by non-semver tags. | |
| 32 | - | ||
| 33 | - | `gordon rollback list <domain>` only lists available tags and marks the current | |
| 34 | - | tag without deploying. | |
| 35 | - | ||
| 36 | - | If the selected tag matches the current running tag, no action is taken. | |
| 37 | - | ||
| 38 | - | ### Examples | |
| 39 | - | ||
| 40 | - | ```bash | |
| 41 | - | # Interactive selection | |
| 42 | - | gordon rollback myapp.example.com | |
| 43 | - | ||
| 44 | - | # Roll back to a specific tag | |
| 45 | - | gordon rollback myapp.example.com --tag v1.2.0 | |
| 46 | - | ||
| 47 | - | # List available tags for a domain | |
| 48 | - | gordon rollback list myapp.example.com | |
| 49 | - | ``` | |
| 50 | - | ||
| 51 | - | ### Notes | |
| 52 | - | ||
| 53 | - | - Remote mode required. See [CLI Overview](./index.md) for targeting options. | |
| 54 | - | - Tags are read from the Gordon registry configured on the server. | |
| 55 | - | ||
| 56 | - | ## Related | |
| 57 | - | ||
| 58 | - | - [CLI Overview](./index.md) | |
| 59 | - | - [Push Command](./push.md) | |
| 60 | - | - [Routes Command](./routes.md) | |
| @@ -1,60 +0,0 @@ | |||||
| 1 | - | # Rollback Command | |||
| 2 | - | ||||
| 3 | - | Roll back a route to a previous image tag. | |||
| 4 | - | ||||
| 5 | - | ## gordon rollback | |||
| 6 | - | ||||
| 7 | - | ### Synopsis | |||
| 8 | - | ||||
| 9 | - | ```bash | |||
| 10 | - | gordon rollback <domain> [options] | |||
| 11 | - | gordon rollback list <domain> | |||
| 12 | - | ``` | |||
| 13 | - | ||||
| 14 | - | ### Arguments | |||
| 15 | - | ||||
| 16 | - | | Argument | Description | | |||
| 17 | - | |----------|-------------| | |||
| 18 | - | | `<domain>` | The route domain to roll back | | |||
| 19 | - | ||||
| 20 | - | ### Options | |||
| 21 | - | ||||
| 22 | - | | Option | Description | | |||
| 23 | - | |--------|-------------| | |||
| 24 | - | | `--tag` | Target tag (skips interactive selection) | | |||
| 25 | - | | `--remote, -r` | Remote name or URL (e.g., prod, https://gordon.mydomain.com) | | |||
| 26 | - | | `--token` | Authentication token for remote | | |||
| 27 | - | ||||
| 28 | - | ### Description | |||
| 29 | - | ||||
| 30 | - | `gordon rollback` deploys a selected tag for the route's repository. | |||
| 31 | - | Semver tags are sorted in descending order first, followed by non-semver tags. | |||
| 32 | - | ||||
| 33 | - | `gordon rollback list <domain>` only lists available tags and marks the current | |||
| 34 | - | tag without deploying. | |||
| 35 | - | ||||
| 36 | - | If the selected tag matches the current running tag, no action is taken. | |||
| 37 | - | ||||
| 38 | - | ### Examples | |||
| 39 | - | ||||
| 40 | - | ```bash | |||
| 41 | - | # Interactive selection | |||
| 42 | - | gordon rollback myapp.example.com | |||
| 43 | - | ||||
| 44 | - | # Roll back to a specific tag | |||
| 45 | - | gordon rollback myapp.example.com --tag v1.2.0 | |||
| 46 | - | ||||
| 47 | - | # List available tags for a domain | |||
| 48 | - | gordon rollback list myapp.example.com | |||
| 49 | - | ``` | |||
| 50 | - | ||||
| 51 | - | ### Notes | |||
| 52 | - | ||||
| 53 | - | - Remote mode required. See [CLI Overview](./index.md) for targeting options. | |||
| 54 | - | - Tags are read from the Gordon registry configured on the server. | |||
| 55 | - | ||||
| 56 | - | ## Related | |||
| 57 | - | ||||
| 58 | - | - [CLI Overview](./index.md) | |||
| 59 | - | - [Push Command](./push.md) | |||
| 60 | - | - [Routes Command](./routes.md) | |||