Skip to content

Commit a9aaabc

Browse files
committed
docs: add release instructions
Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
1 parent d3a70b6 commit a9aaabc

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

+33
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,39 @@ See the [Releases Page](https://github.com/spf13/afero/releases).
431431
4. Push to the branch (`git push origin my-new-feature`)
432432
5. Create new Pull Request
433433

434+
## Releasing
435+
436+
As of version 1.14.0, Afero moved implementations with third-party libraries to
437+
their own submodules.
438+
439+
Releasing a new version now requires a few steps:
440+
441+
```
442+
VERSION=X.Y.Z
443+
git tag -a v$VERSION -m "Release $VERSION"
444+
git push origin v$VERSION
445+
446+
cd gcsfs
447+
go get github.com/spf13/afero@v$VERSION
448+
go mod tidy
449+
git commit -am "Update afero to v$VERSION"
450+
git tag -a gcsfs/v$VERSION -m "Release gcsfs $VERSION"
451+
git push origin gcsfs/v$VERSION
452+
cd ..
453+
454+
cd sftpfs
455+
go get github.com/spf13/afero@v$VERSION
456+
go mod tidy
457+
git commit -am "Update afero to v$VERSION"
458+
git tag -a sftpfs/v$VERSION -m "Release sftpfs $VERSION"
459+
git push origin sftpfs/v$VERSION
460+
cd ..
461+
462+
git push
463+
```
464+
465+
TODO: move these instructions to a Makefile or something
466+
434467
## Contributors
435468

436469
Names in no particular order:

0 commit comments

Comments
 (0)