1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# Contributing to DNSimple/Go
The main `dnsimple` package is defined in the `/dnsimple` subfolder of the `dnsimple/dnsimple-go` repository. Therefore, please note that you will need to move into the subfolder to run any `go` command that assumes the current directory to be the package root.
For example, to get the dependencies you will have to run:
```shell
git clone git@github.com:dnsimple/dnsimple-go.git
cd dnsimple
go get ./...
```
Likewise, when you include this library as dependency, you will need to use
```go
import "github.com/dnsimple/dnsimple-go/dnsimple"
```
and not
```go
import "github.com/dnsimple/dnsimple-go"
```
## Getting started
### 1. Clone the repository
Clone the repository [in your workspace](https://go.dev/doc/code#Organization) and move into it:
```shell
git clone git@github.com:dnsimple/dnsimple-go.git
cd dnsimple-go
```
### 2. Build and test
[Run the test suite](#testing) to check everything works as expected.
## Releasing
The following instructions uses `$VERSION` as a placeholder, where `$VERSION` is a `MAJOR.MINOR.BUGFIX` release such as `1.2.0`.
1. Run the test suite and ensure all the tests pass.
1. Set the version in `dnsimple.go`:
```go
Version = "$VERSION"
```
1. Run the test suite and ensure all the tests pass.
1. Finalize the `## main` section in `CHANGELOG.md` assigning the version.
1. Commit and push the changes
```shell
git commit -a -m "Release $VERSION"
git push origin main
```
1. Wait for CI to complete.
1. Create a signed tag.
```shell
git tag -a v$VERSION -s -m "Release $VERSION"
git push origin --tags
```
## Testing
Submit unit tests for your changes. You can test your changes on your machine by running the test suite (see below).
When you submit a PR, tests will also be run on the [continuous integration environment via GitHub Actions](https://github.com/dnsimple/dnsimple-go/actions).
### Test Suite
To run the test suite:
```shell
go test ./... -v
```
To run the test suite in a live environment (integration):
```shell
export DNSIMPLE_TOKEN="some-token"
go test ./... -v
```
|
