Skip to content

chore: add script to analyze which releases have migrations #10823

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 6 commits into from
Nov 27, 2023
Merged

chore: add script to analyze which releases have migrations #10823

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7bc91f2
chore: add script to analyze which releases have migrations
Emyrk Nov 21, 2023
073b641
add v2 flag
Emyrk Nov 21, 2023
6422921
Add listnig migrations command
Emyrk Nov 21, 2023
2121d8d
Reduce some output noise by only showing ups
Emyrk Nov 21, 2023
c07f2fd
Linting
Emyrk Nov 21, 2023
afa2d94
Add readme to script
Emyrk Nov 27, 2023
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
Prev Previous commit
Add readme to script
  • Loading branch information
@Emyrk
Emyrk committed Nov 27, 2023
commit afa2d948f27940153145f3a086440b2ed4faae32
86 changes: 86 additions & 0 deletions scripts/releasemigrations/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Migration Releases

The `main.go` is a program that lists all releases and which migrations are contained with each upgrade.

# Usage

```bash
releasemigrations [--patches] [--minors] [--majors]
-after-v2
Only include releases after v2.0.0
-dir string
Migration directory (default "coderd/database/migrations")
-list
List migrations
-majors
Include major releases
-minors
Include minor releases
-patches
Include patches releases
-versions string
Comma separated list of versions to use. This skips uses git tag to find tags.
```

# Examples

## Find all migrations between 2 versions

Going from 2.3.0 to 2.4.0

```bash
$ go run scripts/releasemigrations/main.go --list --versions=v2.3.0,v2.4.0 11:47:00 AM
2023/11/21 11:47:09 [minor] 4 migrations added between v2.3.0 and v2.4.0
2023/11/21 11:47:09 coderd/database/migrations/000165_prevent_autostart_days.up.sql
2023/11/21 11:47:09 coderd/database/migrations/000166_template_active_version.up.sql
2023/11/21 11:47:09 coderd/database/migrations/000167_workspace_agent_api_version.up.sql
2023/11/21 11:47:09 coderd/database/migrations/000168_pg_coord_tailnet_v2_api.up.sql
2023/11/21 11:47:09 Patches: 0 (0 with migrations)
2023/11/21 11:47:09 Minors: 1 (1 with migrations)
2023/11/21 11:47:09 Majors: 0 (0 with migrations)
```

## Looking at all patch releases after v2

```bash
$ go run scripts/releasemigrations/main.go --patches --after-v2 11:47:09 AM
2023/11/21 11:48:00 [patch] No migrations added between v2.0.0 and v2.0.1
2023/11/21 11:48:00 [patch] 2 migrations added between v2.0.1 and v2.0.2
2023/11/21 11:48:00 [patch] No migrations added between v2.1.0 and v2.1.1
2023/11/21 11:48:00 [patch] No migrations added between v2.1.1 and v2.1.2
2023/11/21 11:48:00 [patch] No migrations added between v2.1.2 and v2.1.3
2023/11/21 11:48:00 [patch] 1 migrations added between v2.1.3 and v2.1.4
2023/11/21 11:48:00 [patch] 2 migrations added between v2.1.4 and v2.1.5
2023/11/21 11:48:00 [patch] 1 migrations added between v2.3.0 and v2.3.1
2023/11/21 11:48:00 [patch] 1 migrations added between v2.3.1 and v2.3.2
2023/11/21 11:48:00 [patch] 1 migrations added between v2.3.2 and v2.3.3
2023/11/21 11:48:00 Patches: 10 (6 with migrations)
2023/11/21 11:48:00 Minors: 4 (4 with migrations)
2023/11/21 11:48:00 Majors: 0 (0 with migrations)
```

## Seeing all the noise this thing can make

This shows when every migration was introduced.

```bash
$ go run scripts/releasemigrations/main.go --patches --minors --majors --list
# ...
2023/11/21 11:48:31 [minor] 5 migrations added between v2.2.1 and v2.3.0
2023/11/21 11:48:31 coderd/database/migrations/000160_provisioner_job_status.up.sql
2023/11/21 11:48:31 coderd/database/migrations/000161_workspace_agent_stats_template_id_created_at_user_id_include_sessions.up.sql
2023/11/21 11:48:31 coderd/database/migrations/000162_workspace_automatic_updates.up.sql
2023/11/21 11:48:31 coderd/database/migrations/000163_external_auth_extra.up.sql
2023/11/21 11:48:31 coderd/database/migrations/000164_archive_template_versions.up.sql
2023/11/21 11:48:31 [patch] 1 migrations added between v2.3.0 and v2.3.1
2023/11/21 11:48:31 coderd/database/migrations/000165_prevent_autostart_days.up.sql
2023/11/21 11:48:31 [patch] 1 migrations added between v2.3.1 and v2.3.2
2023/11/21 11:48:31 coderd/database/migrations/000166_template_active_version.up.sql
2023/11/21 11:48:31 [patch] 1 migrations added between v2.3.2 and v2.3.3
2023/11/21 11:48:31 coderd/database/migrations/000167_workspace_agent_api_version.up.sql
2023/11/21 11:48:31 [minor] 1 migrations added between v2.3.3 and v2.4.0
2023/11/21 11:48:31 coderd/database/migrations/000168_pg_coord_tailnet_v2_api.up.sql
2023/11/21 11:48:31 Patches: 122 (55 with migrations)
2023/11/21 11:48:31 Minors: 31 (26 with migrations)
2023/11/21 11:48:31 Majors: 1 (1 with migrations)
```
2 changes: 1 addition & 1 deletion scripts/releasemigrations/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func main() {
}

func usage() {
_, _ = fmt.Println("Usage: releasemigrations [--patches] [--minors] [--majors]")
_, _ = fmt.Println("Usage: releasemigrations [--patches] [--minors] [--majors] [--list]")
_, _ = fmt.Println("Choose at lease one of --patches, --minors, or --majors. You can choose all!")
_, _ = fmt.Println("Must be run from the coder repo at the root.")
}
Expand Down