Initial Commit

README.md

@@ -0,0 +1,79 @@
+Bitbucket Server Terraform Provider
+==================
+
+This terraform provider allows management of bitbucket server resources.
+
+> Note: The bundled terraform bitbucket provider works for bitbucket cloud - this provider is for bitbucket server only!
+
+## Using the provider
+
+Download a binary for your system from the release page and remove the `-os-arch` details so you're left with `terraform-provider-bitbucketserver`.
+Use `chmod +x` to make it executable and then either place it at the root of your Terraform folder or in the Terraform plugin folder on your system. 
+
+### Quick Start
+
+```hcl
+provider "bitbucketserver" {
+  server   = "https://mybitbucket.example.com"
+  username = "admin"
+  password = "password"
+}
+
+resource "bitbucketserver_repository" "test" {
+  project     = "TEST"
+  name        = "test-01"
+  description = "Test repository"
+}
+```
+
+---
+
+## Development Guide
+
+### Requirements
+
+-	[Terraform](https://www.terraform.io/downloads.html) 0.10.x
+-	[Go](https://golang.org/doc/install) 1.11 (to build the provider plugin)
+
+### Building The Provider
+
+Clone repository to: `$GOPATH/src/github.com/gavinbunney/terraform-provider-bitbucketserver`
+
+```sh
+$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
+$ git clone git@github.com:gavinbunney/terraform-provider-bitbucketserver
+```
+
+Enter the provider directory and build the provider
+
+```sh
+$ cd $GOPATH/src/github.com/gavinbunney/terraform-provider-bitbucketserver
+$ make build
+```
+
+### Developing the Provider
+
+If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.11+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
+
+To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
+
+```sh
+$ make bin
+...
+$ $GOPATH/bin/terraform-provider-bitbucketserver
+...
+```
+
+In order to test the provider, you can simply run `make test`.
+
+```sh
+$ make test
+```
+
+In order to run the full suite of Acceptance tests, run `make testacc`.
+
+*Note:* Acceptance tests create real resources, and often cost money to run.
+
+```sh
+$ make testacc
+```