Skip to content

Commit

Permalink
Merge pull request hashicorp#49 from hashicorp/f/change-bschaatsberge…
Browse files Browse the repository at this point in the history
…n-to-hashicorp

feat: move to `hashicorp` namespace
  • Loading branch information
bschaatsbergen authored Jul 25, 2024
2 parents 45c0426 + 9046579 commit c824713
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 24 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Terraform Provider: Assert

The [Assert Terraform provider]((https://registry.terraform.io/providers/bschaatsbergen/assert/latest/docs)) is intended for use when writing [Terraform tests](https://developer.hashicorp.com/terraform/language/tests). It serves as a way to verify that the values in your Terraform configuration meet specific criteria. The provider only contains functions to assert values, and does not manage any resources.
The [Assert Terraform provider]((https://registry.terraform.io/providers/hashicorp/assert/latest/docs)) is intended for use when writing [Terraform tests](https://developer.hashicorp.com/terraform/language/tests). It serves as a way to verify that the values in your Terraform configuration meet specific criteria. The provider only contains functions to assert values, and does not manage any resources.

* [Terraform Registry](https://registry.terraform.io/providers/bschaatsbergen/assert/latest/docs)
* [Contributor Guide](https://bschaatsbergen.github.io/terraform-provider-assert/)
* [Terraform Registry](https://registry.terraform.io/providers/hashicorp/assert/latest/docs)
* [Contributor Guide](https://hashicorp.github.io/terraform-provider-assert/)

To use provider functions, declare the provider as a required provider in your Terraform configuration:

```hcl
terraform {
required_providers {
assert = {
source = "bschaatsbergen/assert"
source = "hashicorp/assert"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Define the provider as a `required_provider` to use its functions
terraform {
required_providers {
assert = {
source = "bschaatsbergen/assert"
source = "hashicorp/assert"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion examples/provider/provider.tf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
terraform {
required_providers {
assert = {
source = "bschaatsbergen/assert"
source = "hashicorp/assert"
}
}
}
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/bschaatsbergen/terraform-provider-assert
module github.com/hashicorp/terraform-provider-assert

go 1.21

Expand Down
4 changes: 2 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import (
"flag"
"log"

"github.com/bschaatsbergen/terraform-provider-assert/internal/provider"
"github.com/hashicorp/terraform-plugin-framework/providerserver"
"github.com/hashicorp/terraform-provider-assert/internal/provider"
)

// Run "go generate" to format example terraform files and generate the docs for the registry/website
Expand Down Expand Up @@ -38,7 +38,7 @@ func main() {
flag.Parse()

opts := providerserver.ServeOpts{
Address: "registry.terraform.io/bschaatsbergen/assert",
Address: "registry.terraform.io/hashicorp/assert",
Debug: debug,
}

Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
site_name: Terraform Assert Provider - Contributor Guide
site_description: 'Contributor guide for the Terraform Assert Provider'
copyright: HashiCorp
repo_name: bschaatsbergen/terraform-provider-assert
repo_url: https://github.com/bschaatsbergen/terraform-provider-assert
edit_uri: "https://github.com/bschaatsbergen/terraform-provider-assert/tree/main/mkdocs"
repo_name: hashicorp/terraform-provider-assert
repo_url: https://github.com/hashicorp/terraform-provider-assert
edit_uri: "https://github.com/hashicorp/terraform-provider-assert/tree/main/mkdocs"

docs_dir: mkdocs

Expand Down
2 changes: 1 addition & 1 deletion mkdocs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Documentation

This directory contains documentation for the [Terraform Assert Provider Contributor Guide](https://bschaatsbergen.github.io/terraform-provider-assert/).
This directory contains documentation for the [Terraform Assert Provider Contributor Guide](https://hashicorp.github.io/terraform-provider-assert/).

## Local Development

Expand Down
2 changes: 1 addition & 1 deletion mkdocs/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To do this, populate a Terraform CLI configuration file (`~/.terraformrc` for al
```terraform
provider_installation {
dev_overrides {
"bschaatsbergen/assert" = "[REPLACE WITH GOPATH]/bin"
"hashicorp/assert" = "[REPLACE WITH GOPATH]/bin"
}
direct {}
}
Expand Down
2 changes: 1 addition & 1 deletion mkdocs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ If there's new functionality or bug fixes, we aim to release every week. If ther

Great question, if you have contributed before check out issues with the `help-wanted` label. These are normally enhancement issues that will have a great impact, but the maintainers are unable to develop them in the near future. If you are just getting started, take a look at issues with the `good-first-issue` label. Items with these labels will always be given priority for response.

Check out the [Contributing Guide](https://bschaatsbergen.github.io/terraform-provider-assert/) for additional information.
Check out the [Contributing Guide](https://hashicorp.github.io/terraform-provider-assert/) for additional information.
8 changes: 4 additions & 4 deletions mkdocs/generating-documentation.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Generating Documentation

This provider uses [terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs/) to generate documentation and store it in the [docs/](https://github.com/bschaatsbergen/terraform-provider-assert/tree/main/docs) directory. Once a release is cut, the Terraform Registry will download the documentation from [docs/](https://github.com/bschaatsbergen/terraform-provider-assert/tree/main/docs) and associate it with the release version. Read more about how this works on the official page.
This provider uses [terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs/) to generate documentation and store it in the [docs/](https://github.com/hashicorp/terraform-provider-assert/tree/main/docs) directory. Once a release is cut, the Terraform Registry will download the documentation from [docs/](https://github.com/hashicorp/terraform-provider-assert/tree/main/docs) and associate it with the release version. Read more about how this works on the official page.

### Adding documentation for a new function

To add documentation for a new function, you need to do 2 things:

* Add a `<function>.md.tmpl` file in the [templates/](https://github.com/bschaatsbergen/terraform-provider-assert/tree/main/templates) directory. This file is used by [terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs/) to generate the documentation. You can refer to one of the existing files to create a new one.
* Add a `<function>.md.tmpl` file in the [templates/](https://github.com/hashicorp/terraform-provider-assert/tree/main/templates) directory. This file is used by [terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs/) to generate the documentation. You can refer to one of the existing files to create a new one.

* Add examples to the [examples/](https://github.com/bschaatsbergen/terraform-provider-assert/tree/main/examples) directory. These examples are referenced in the template files and are used to generate the examples section in the documentation. We recommend adding an example for Terraform Test and Variable Validation. You can refer to one of the existing examples to create a new one.
* Add examples to the [examples/](https://github.com/hashicorp/terraform-provider-assert/tree/main/examples) directory. These examples are referenced in the template files and are used to generate the examples section in the documentation. We recommend adding an example for Terraform Test and Variable Validation. You can refer to one of the existing examples to create a new one.


### Generating documentation

After adding a new function to the [templates/](https://github.com/bschaatsbergen/terraform-provider-assert/tree/main/templates) and [examples/](https://github.com/bschaatsbergen/terraform-provider-assert/tree/main/examples) directories, run:
After adding a new function to the [templates/](https://github.com/hashicorp/terraform-provider-assert/tree/main/templates) and [examples/](https://github.com/hashicorp/terraform-provider-assert/tree/main/examples) directories, run:

```sh
make generate
Expand Down
8 changes: 4 additions & 4 deletions mkdocs/issue-reporting-and-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ issues of each type.

We encourage opening new issues rather than commenting on closed issues if a problem has not been completely solved or causes a regression. This ensures we are able to triage it effectively.

### [Bug Reports](https://github.com/bschaatsbergen/terraform-provider-assert/issues/new?template=Bug_Report.md)
### [Bug Reports](https://github.com/hashicorp/terraform-provider-assert/issues/new?template=Bug_Report.md)

- __Test against the latest release__: Make sure you test against the latest
released version. It is possible we already fixed the bug you're experiencing.

- __Search for possible duplicate reports__: It's helpful to keep bug
reports consolidated to one thread, so do a quick search on existing bug
reports to check if anybody else has reported the same thing. You can [scope
searches by the label "bug"](https://github.com/bschaatsbergen/terraform-provider-assert/issues?q=is%3Aopen+is%3Aissue+label%3Abug) to help narrow things down.
searches by the label "bug"](https://github.com/hashicorp/terraform-provider-assert/issues?q=is%3Aopen+is%3Aissue+label%3Abug) to help narrow things down.

- __Include steps to reproduce__: Provide steps to reproduce the issue,
along with your `.tf` files, with secrets removed, so we can try to
Expand All @@ -26,12 +26,12 @@ We encourage opening new issues rather than commenting on closed issues if a pro
create a [gist](https://gist.github.com) of the *entire* generated crash log
for us to look at. Double-check check no sensitive items were in the log.

### [Feature Requests](https://github.com/bschaatsbergen/terraform-provider-assert/issues/new?labels=enhancement&template=Feature_Request.md)
### [Feature Requests](https://github.com/hashicorp/terraform-provider-assert/issues/new?labels=enhancement&template=Feature_Request.md)

- __Search for possible duplicate requests__: It's helpful to keep requests
consolidated to one thread, so do a quick search on existing requests to
check if anybody else has reported the same thing. You can [scope searches by
the label "enhancement"](https://github.com/bschaatsbergen/terraform-provider-assert/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) to help narrow things down.
the label "enhancement"](https://github.com/hashicorp/terraform-provider-assert/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) to help narrow things down.

- __Include a use case description__: In addition to describing the
behavior of the feature you'd like to see added, it's helpful to also lay
Expand Down
2 changes: 1 addition & 1 deletion mkdocs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Releasing

The release process is automated via GitHub Actions, and defined in the Workflow [release.yml](https://github.com/bschaatsbergen/terraform-provider-assert/blob/main/.github/workflows/release.yml).
The release process is automated via GitHub Actions, and defined in the Workflow [release.yml](https://github.com/hashicorp/terraform-provider-assert/blob/main/.github/workflows/release.yml).

Each release is cut by pushing a [semantically versioned](https://semver.org/) tag to the default branch.

0 comments on commit c824713

Please sign in to comment.