Skip to content
Snippets Groups Projects
Commit b4244157 authored by Francé Wilke's avatar Francé Wilke
Browse files

Update readme with new release instructions

parent 0b4defe5
Branches
Tags
No related merge requests found
...@@ -2,19 +2,24 @@ ...@@ -2,19 +2,24 @@
A set of utilities used by our Golang projects A set of utilities used by our Golang projects
* [errors](./errors/README.md) * [errors](./errors/README.md)
## Creating a new tag ## Creating a new release
When making changes, a new tag needs to be made in order to use the updated library in your project. First pull the tags, and check the latest version. When making changes, a new release needs to be made in order to use the updated library in your project.
`git pull --tags` 1. First, make sure your `uafrica-tools` repository is up to date (minimum at commit `442f62f0`):
```
`git tag` git pull
make install
The output will be a list of tags. Create a new tag with the version number increased. E.g. if the last tag was `v1.2.7`, the new tag could be `v1.2.8`. Then push the tag. ```
`git tag -a v1.2.8 -m "Tag v1.2.8"` 2. After your changes have been merged to the `main` branch of `go-utils`, run the following command which will automatically create a new tag:
```
`git push --tags` ua release
```
For your project, upgrade to the new version by running the `go get` command. and select project `uafrica/go-utils`
`go get gitlab.com/uafrica/go-utils@v1.2.8` 3. For your project, upgrade to the new version by running the `go get` command and specifying the new tab:
\ No newline at end of file ```
go get gitlab.com/uafrica/go-utils@v1.6.0
```
**Note:** The release documentation can be found in GitLab, by navigating to the new tag. For example: https://gitlab.com/uafrica/go-utils/-/tags/v1.6.0
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment