Skip to content

Commit 0beff51

Browse files
committed
Update README to describe how to version tag migrations
1 parent 9d87b9e commit 0beff51

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,18 @@ To create a new migration, create a go module in a directory named `fs-repo-X-to
6767

6868
If the migration directory contains a subdirectory named `sharness`, tests contained in it are run using the sharness test tool. Tests must be named `tNNNN-*.sh`, where NNNN is a 4-digit sequence number.
6969

70+
After the migration is merged into the main repo branch, create a version tag for it. This is necessary for versioning individual migrations within the repo.
71+
```sh
72+
git tag <migration>/v<version>
73+
git push origin <migration>/v<version>
74+
```
75+
76+
Example:
77+
```sh
78+
git tag fs-repo-99-100/v1.0.1
79+
git push origin fs-repo-99-100/v1.0.1
80+
```
81+
7082
### Dependencies
7183

7284
Dependencies must be vendored independently for each migration. Each migration is a separate go module with its own `vendor` directory (created with `go mod vendor` for that migration). All migrations are built using `go build -mod=vendor` to ensure dependencies come from the module's `vendor` directory.

0 commit comments

Comments
 (0)