Skip to content

chore: Prettify README.md #329

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 22, 2025
Merged

chore: Prettify README.md #329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ to setup your local Terraform to use your local version rather than the registry

To run Terraform acceptance tests, run `make testacc`. This will test the provider against the locally installed version of Terraform.

> **Note:** our [CI workflow](./github/workflows/test.yml) runs a test matrix against multiple Terraform versions.
> [!Note]
> Our [CI workflow](./github/workflows/test.yml) runs a test matrix against multiple Terraform versions.

#### Integration Tests

Expand All @@ -75,11 +76,13 @@ To run these integration tests locally:

1. Run `CODER_IMAGE=ghcr.io/coder/coder-preview CODER_VERSION=main-x.y.z-devel-abcd1234 make test-integration`.

> **Note:** you can specify `CODER_IMAGE` if the Coder image you wish to test is hosted somewhere other than `ghcr.io/coder/coder`.
> [!Note]
> You can specify `CODER_IMAGE` if the Coder image you wish to test is hosted somewhere other than `ghcr.io/coder/coder`.
> For example, `CODER_IMAGE=example.com/repo/coder CODER_VERSION=foobar make test-integration`.

### How to create a new release
> **Warning:** Before creating a new release, make sure you have pulled the latest commit from the main branch i.e. `git pull origin main`
> [!Warning]
> Before creating a new release, make sure you have pulled the latest commit from the main branch i.e. `git pull origin main`

1. Create a new tag with a version number (following semantic versioning):
```console
Expand All @@ -91,4 +94,4 @@ To run these integration tests locally:
git push origin tag v2.1.2
```

A GitHub Actions workflow named "Release" will automatically trigger, run integration tests, and publish the new release.
A GitHub Actions workflow named "Release" will automatically trigger, run integration tests, and publish the new release.
Loading