Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: brand updates #531

Merged
merged 1 commit into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

## Our Pledge

We as members, contributors, and leaders pledge to make participation in terraform-provider-vra project and our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We as members, contributors, and leaders pledge to make participation in the
project and our community a harassment-free experience for everyone, regardless
of age, body size, visible or invisible disability, ethnicity, sex
characteristics, gender identity and expression, level of experience, education,
socio-economic status, nationality, personal appearance, race, religion, or
sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
Expand Down Expand Up @@ -59,8 +59,9 @@ representative at an online or offline event.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at [email protected].
All complaints will be reviewed and investigated promptly and fairly.
reported to the community leaders responsible for enforcement at
[email protected]. All complaints will be reviewed and investigated
promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Expand Down
23 changes: 11 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Contributing to terraform-provider-vra
# Contributing

The terraform-provider-vra project team welcomes contributions from the community. Before you start working with terraform-provider-vra, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
The project team welcomes contributions from the community.

Before you start working with the provider, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

## Contribution Flow

Expand All @@ -23,7 +25,7 @@ git push origin my-new-feature

### Staying In Sync With Upstream

When your branch gets out of sync with the vmware/main branch, use the following to update:
When your branch gets out of sync with the `vmware/main` branch, use the following to update:

``` shell
git checkout my-new-feature
Expand All @@ -32,13 +34,11 @@ git pull --rebase upstream main
git push --force-with-lease origin my-new-feature
```

### Updating pull requests
### Updating Pull Requests

If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
existing commits.
If your pull request fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into existing commits.

If your pull request contains a single commit or your changes are related
to the most recent commit, you can simply amend the commit.
If your pull request contains a single commit or your changes are related to the most recent commit, you can simply amend the commit.

``` shell
git add .
Expand All @@ -55,17 +55,16 @@ git rebase -i --autosquash main
git push --force-with-lease origin my-new-feature
```

Be sure to add a comment to the PR indicating your new changes are ready to
review, as GitHub does not generate a notification when you git push.
Be sure to add a comment to the pull request indicating your new changes are ready to review, as GitHub does not generate a notification when you `git push`.

### Formatting Commit Messages

We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).

Be sure to include any related GitHub issue references in the commit message.

See [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues and commits.

## Reporting Bugs and Creating Issues

When opening a new issue, try to roughly follow the commit message format
conventions above.
When opening a new issue, try to roughly follow the commit message format conventions above.
45 changes: 30 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,57 @@
# Terraform Provider for VMware vRealize Automation
# Terraform Provider for VMware Aria Automation

A self-contained deployable integration between Terraform and VMware vRealize Automation which allows Terraform users to request and provision IaaS resources such as machines, networks, load balancers, along with the configuration of cloud accounts, zones, and projects. This provider supports both vRealize Automation Cloud (SaaS) and vRealize Automation 8 (on-premises).
A self-contained deployable integration between Terraform and VMware Aria Automation which allows Terraform users to request and provision IaaS resources such as machines, networks, load balancers, along with the configuration of cloud accounts, zones, and projects.

This provider supports VMware Aria Automation 8.

## Requirements

* [Terraform 0.12+](https://www.terraform.io/downloads.html)
* [Go 1.20](https://golang.org/dl/) (to build the provider plugin)
- [Terraform 0.13+][terraform-install]

For general information about Terraform, visit [developer.hashicorp.com][terraform-install] and [the project][terraform-github] on GitHub.

- [Go 1.20][golang-install]

Required if building the provider.

## Using the Provider

The [Terraform Provider for VMware vRealize Automation](https://registry.terraform.io/providers/vmware/vra/latest) is a verified provider. Verified providers are owned and maintained by members of the HashiCorp Technology Partner Program. HashiCorp verifies the authenticity of the publisher and the providers are listed on the Terraform Registry with a verified tier label.
The [Terraform Provider for VMware Aria Automation](https://registry.terraform.io/providers/vmware/vra/latest) is a partner provider. Partner providers are owned and maintained by members of the HashiCorp Technology Partner Program. HashiCorp verifies the authenticity of the publisher and the providers are listed on the Terraform Registry with a `Partner` label.

To use a released version of the Terraform provider in your environment, run [`terraform init`](https://www.terraform.io/docs/commands/init.html) and Terraform will automatically install the provider from the Terraform Registry.
To use a released version of the Terraform provider in your environment, run [`terraform init`](https://www.terraform.io/docs/commands/init.html) and Terraform will automatically install the provider from the Terraform Registry.

See [Installing the Terraform Provider for VMware vRealize Automation](docs/install_provider.md) for additional instructions on automated and manual installation methods and how to control the provider version.
Refer to [Installing the Terraform Provider for VMware Aria Automation](docs/install_provider.md) for additional instructions on automated and manual installation methods and how to control the provider version.

For either installation method, documentation about the provider configuration, resources, and data sources can be found on the [provider page](https://registry.terraform.io/providers/vmware/vra/latest/docs) on the Terraform Registry.

The provider accepts either a `refresh_token` or an `access_token` to interact with the vRealize Automation API, but not both at the same time.
The provider accepts either a `refresh_token` or an `access_token` to interact with the product API, but not both at the same time.

* For more information on obtaining a `refresh_token` for the provider configuration the provider, see [Get Your Refresh Token for the vRealize Automation API](docs/refresh_token.md).
For more information on obtaining a `refresh_token` for the provider configuration the provider, refer [Get Your Refresh Token for the VMware Aria Automation API](docs/refresh_token.md).

* For more information on obtaining an `access_token` for the provider configuration, see [Get Your Access Token for the vRealize Automation API](https://code.vmware.com/docs/14701/vrealize-automation-8-6-api-programming-guide/GUID-AC1E4407-6139-412A-B4AA-1F102942EA94.html) on VMware {code}.

Examples on the use of the provider configuration, resources, and data sources can be found in the project's `examples` directory.
Examples on the use of the provider configuration, resources, and data sources can be found in the project's `examples` directory.

## Upgrading the Provider

The provider does not upgrade automatically. After each new release, you can run the following command to upgrade the provider:
The provider does not upgrade automatically. After each new release, you can run the following command to upgrade the provider:

```bash
terraform init -upgrade
```

## Contributing

The project team welcomes contributions from the community. Before you start working with terraform-provider-vra, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).
The project team welcomes contributions from the community. Please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

If you discover a bug or would like to suggest an enhancement, submit [an issue][provider-issues].

If you would like to submit a pull request, please read the [contribution guidelines][provider-contributing] to get started. In case of enhancement or feature contribution, we kindly ask you to open an issue to discuss it beforehand.

## License

The Terraform Provider for VMware vRealize Automation is available under the [Mozilla Public License, version 2.0 license](LICENSE).
The Terraform Provider for VMware Aria Automation is available under the [Mozilla Public License, version 2.0 license](LICENSE).

[golang-install]: https://golang.org/doc/install
[provider-contributing]: CONTRIBUTING.md
[provider-issues]: https://github.com/vmware/terraform-provider-vra/issues/new/choose
[terraform-install]: https://developer.hashicorp.com/terraform/install
[terraform-github]: https://github.com/hashicorp/terraform
39 changes: 19 additions & 20 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,41 @@
# Releasing

Steps to Release a New Version
------------------------------
## Steps to Release a New Version

- Make sure your local copy of the repository is up to date:

```
git pull --rebase
```
```shell
git pull --rebase
```

- Verify CI tests:

```
make fmtcheck errcheck lint
```
```shell
make fmtcheck errcheck lint
```

- Verify build and tests:

```
make build test
```
```shell
make build test
```

- Tag with annotation:

```
git tag -a v0.0.0 -m "Release v0.0.0"
```
```shell
git tag -a v0.0.0 -m "Release v0.0.0"
```

- Verify the tag:

```
git tag -l -n
```
```shell
git tag -l -n
```

- Push the tag:

```
git push --tags
```
```shell
git push --tags
```

- A [Release Github Action](https://github.com/vmware/terraform-provider-vra/actions/workflows/release.yml) will automatically be triggered, and a [draft release](https://github.com/vmware/terraform-provider-vra/releases) will be created.
Loading
Loading