fix: enable builds on windows (#273)

This commit updates the project to enable
builds to be performed on Windows.
I also bumped the go core version to the current latest.

Signed-off-by: Phil Adams <phil_adams@us.ibm.com>

CONTRIBUTING.md

@@ -12,6 +12,18 @@ Before that, please search for similar issues. It's possible that someone has al
 For general guidance on contributing to this project, please see
 [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/CONTRIBUTING_go.md)
 
+# Prerequisites
+The following tools are required in order to build this project:
+* Git
+* A modern version of the `make` utility.  
+    Note: Windows users will likely need to install one of the various 
+    [make utilities available for Windows](https://www.google.com/search?q=make+utility+for+windows).
+* A version of [Go](https://www.google.com/search?q=install+golang) that is >= the
+minimum version supported by the project.
+
+Windows users might find it more convenient to use
+[`Windows Subsystem for Linux (WSL)`](https://learn.microsoft.com/en-us/windows/wsl/about)
+or [`Cygwin`](https://www.cygwin.com/) when making contributions to this project.
+
 # Updating an existing service within the SDK
-For instructions on updating an existing service within the SDK, please see
-[this link](update_service.md)
+For instructions on updating an existing service within the SDK, please see [update_service.md](update_service.md)

Makefile

@@ -9,16 +9,16 @@ all: tidy test lint
 travis-ci: tidy test-cov lint scan-gosec
 
 test:
-	${GO} test `${GO} list ./...`
+	${GO} test ./...
 
 test-cov:
-	${GO} test `${GO} list ./...` ${COVERAGE}
+	${GO} test ./... ${COVERAGE}
 
 test-int:
-	${GO} test `${GO} list ./...` -tags=integration
+	${GO} test ./... -tags=integration
 
 test-int-cov:
-	${GO} test `${GO} list ./...` -tags=integration ${COVERAGE}
+	${GO} test ./... -tags=integration ${COVERAGE}
 
 lint:
 	${LINT} run --build-tags=integration,examples --timeout 120s

go.mod

@@ -3,7 +3,7 @@ module github.com/IBM/platform-services-go-sdk
 go 1.19
 
 require (
-	github.com/IBM/go-sdk-core/v5 v5.13.2
+	github.com/IBM/go-sdk-core/v5 v5.14.1
 	github.com/go-openapi/strfmt v0.21.5
 	github.com/google/uuid v1.3.0
 	github.com/onsi/ginkgo v1.16.5

go.sum

@@ -1,5 +1,5 @@
-github.com/IBM/go-sdk-core/v5 v5.13.2 h1:C/JWnEadKzonoHFZdMX8DaSxGVqKRFhcpDXFS5bPDiA=
-github.com/IBM/go-sdk-core/v5 v5.13.2/go.mod h1:gKRSB+YyKsGlRQW7v5frlLbue5afulSvrRa4O26o4MM=
+github.com/IBM/go-sdk-core/v5 v5.14.1 h1:WR1r0zz+gDW++xzZjF41r9ueY4JyjS2vgZjiYs8lO3c=
+github.com/IBM/go-sdk-core/v5 v5.14.1/go.mod h1:MUvIr/1mgGh198ZXL+ByKz9Qs1JoEh80v/96x8jPXNY=
 github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw=
 github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 h1:DklsrG3dyBCFEj5IhUbnKptjxatkF07cF2ak3yi77so=
 github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw=

update_service.md

@@ -48,7 +48,10 @@ to your external github.com id. The id linking step will also result in an invit
 `github.com/IBM` org. Accept that invitation.
 3. If you do not yet have "push" access to the SDK project, contact the project maintainer to request push access
 (you must be a member of the github.com/IBM org).
-4. Make sure that your installed version of Go is >= the minimum version supported by the SDK project.
+4. Make sure that you have installed the [tools required to build the project](CONTRIBUTING.md#prerequisites).
+5. To update a service, make sure the following additional tools are installed:
+* The [IBM OpenAPI Validator](https://github.com/IBM/openapi-validator)
+* The [IBM OpenAPI SDK Generator](github.ibm.com/CloudEngineering/openapi-sdkgen)
 
 ## Initial project setup
 1. Clone/fork the repo.  If you have push access (see above), you can clone the repo directly (no fork).  
@@ -253,3 +256,4 @@ as mentioned above.
 - [IBM OpenAPI Validator](https://github.com/IBM/openapi-validator)
 - [IBM OpenAPI SDK Generator](https://github.ibm.com/CloudEngineering/openapi-sdkgen)
 - [Effective Go - The Go Programming Language](https://golang.org/doc/effective_go)
+- [Go Documentation: Download and install](https://go.dev/doc/install)