docs: add namespace migration guide (#112)

Adds a small migration guide for existing users still using the previous hashicorp namespace.
hetznercloud · Nov 7, 2023 · dd3d327 · dd3d327
1 parent f83c8e9
commit dd3d327
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/.go-version b/.go-version
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ binary file can be found in the root directory.
 To install the compiled plugin, please follow the official Packer documentation
 on [installing a plugin](https://www.packer.io/docs/extending/plugins/#installing-plugins).
 
-### Configuration
+## Configuration
 
 For more information on how to configure the plugin, please read the
 documentation located in the [`docs/`](docs) directory.

diff --git a/docs/README.md b/docs/README.md
@@ -22,6 +22,22 @@ Alternatively, you can use `packer plugins install` to manage installation of th
 $ packer plugins install github.com/hetznercloud/hcloud
 ```
 
+#### Migrate from `github.com/hashicorp/hcloud`
+
+On the 7 November 2023, the Packer plugin source moved from `github.com/hashicorp/hcloud` to `github.com/hetznercloud/hcloud`, make sure to update your Packer configuration with the new source:
+
+```patch
+ packer {
+   required_plugins {
+     hcloud = {
+-      source  = "github.com/hashicorp/hcloud"
++      source  = "github.com/hetznercloud/hcloud"
+       version = ">= 1.1.1"
+     }
+   }
+ }
+```
+
 ### Components
 
 #### Builders