Merge pull request #23 from hashicorp/readme

Add Readme and License

Author: SBGoods

.changes/unreleased/.gitkeep

@@ -0,0 +1,6 @@
+kind: NOTES
+body: Same testing functionality as that of terraform-plugin-sdk v2.24.1, repacked
+  in a standalone repository
+time: 2023-01-10T12:37:37.053752-05:00
+custom:
+  Issue/PR Number: "24"

.changes/unreleased/NOTES-20230110-123737.yaml

@@ -0,0 +1,21 @@
+changesDir: .changes
+unreleasedDir: unreleased
+changelogPath: CHANGELOG.md
+versionExt: md
+versionFormat: '## {{.Version}} ({{.Time.Format "January 02, 2006"}})'
+kindFormat: '{{.Kind}}:'
+changeFormat: '* {{.Body}} ([#{{.Custom.Issue}}](https://github.com/hashicorp/terraform-provider-testing/issues/{{.Custom.Issue}}))'
+custom:
+  - key: Issue/PR Number
+    type: int
+    minInt: 1
+kinds:
+  - label: BREAKING CHANGES
+  - label: NOTES
+  - label: FEATURES
+  - label: IMPROVEMENTS
+  - label: BUG FIXES
+newlines:
+  afterKind: 1
+  beforeKind: 1
+  endOfVersion: 2

.changie.yaml

@@ -0,0 +1,6 @@
+schema_version = 1
+
+project {
+  license = "MPL-2.0"
+  copyright_year = 2014
+}

.copywrite.hcl

@@ -108,6 +108,16 @@ attaching use cases to an issue first before raising a pull request.
   commands). Where possible it is better to raise a separate pull request with
   just dependency changes as it's easier to review such PR(s).
 
+- [ ] **Changelog**: We use the [Changie](https://changie.dev/) automation tool 
+  for changelog automation. To add a new entry to the `CHANGELOG` install Changie 
+  using the following [instructions](https://changie.dev/guide/installation/)
+  and run `changie new` then choose a `kind` of change corresponding to the Terraform 
+  Plugin [changelog categories](https://developer.hashicorp.com/terraform/plugin/sdkv2/best-practices/versioning#categorization) 
+  and then fill out the body following the entry format. Changie will then prompt for 
+  a Github issue or pull request number. Repeat this process for any additional changes. 
+  The `.yaml` files created in the `.changes/unreleased` folder should be pushed the repository 
+  along with any code changes.
+
 ### Cosmetic changes, code formatting, and typos
 
 In general we do not accept PRs containing only the following changes:
@@ -221,30 +231,8 @@ This section is dedicated to the maintainers of this project.
 
 ### Releases
 
-Before running a release, the changelog must be constructed from unreleased entries in the `.changelog` directory.
-
-Install the latest version of the [`changelog-build`](https://pkg.go.dev/github.com/hashicorp/go-changelog/cmd/changelog-build) command, if it not already available:
-
-```shell
-go install github.com/hashicorp/go-changelog/cmd/changelog-build
-```
-
-Run the [`changelog-build`](https://pkg.go.dev/github.com/hashicorp/go-changelog/cmd/changelog-build) command from the root directory of the repository:
-
-```shell
-changelog-build -changelog-template .changelog.tmpl -entries-dir .changelog -last-release $(git describe --tags --abbrev=0) -note-template .changelog-note.tmpl -this-release HEAD
-```
-
-This will generate a section of Markdown text for the next release. Open the `CHANGELOG.md` file, add a `# X.Y.Z` header as the first line, then add the output from the `changelog-build` command.
-
-Commit, push, create a release Git tag, and push the tag:
-
-```shell
-git add CHANGELOG.md
-git commit -m "Update CHANGELOG for v1.2.3"
-git push
-git tag v1.2.3
-git push --tags
-```
-
-GitHub Actions will pick up the new release tag and kick off the release workflow.
+To cut a release, go to the repository in Github and click on the `Actions` tab 
+and select the `Release` workflow on the left-hand menu. In the `Release` submenu, 
+click on the Run workflow button, select the branch to cut the release from (default is main)
+and input the `Release version number` which is the Semantic Release number including 
+the `v` prefix (i.e. `v1.4.0`) and click `Run workflow`

.github/CONTRIBUTING.md

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 blank_issues_enabled: false
 contact_links:
   - name: Terraform Language or Workflow Feedback and Questions

.github/ISSUE_TEMPLATE/config.yml

@@ -8,9 +8,9 @@ labels: enhancement
 <!--
 Inspect your go.mod as below to find the version, and paste the result between the ``` marks below.
 
-go list -m github.com/hashicorp/terraform-plugin-log/...
+go list -m github.com/hashicorp/terraform-plugin-testing/...
 
-If you are not running the latest version of terraform-plugin-log, please try
+If you are not running the latest version of terraform-plugin-testing, please try
 upgrading because your feature may have already been implemented.
 -->
 ```
@@ -28,7 +28,7 @@ a moment, below!
 
 ### Attempted solutions
 <!---
-If you've already tried to solve the problem within terraform-plugin-log's
+If you've already tried to solve the problem within terraform-plugin-testing's
 existing features and found a limitation that prevented you from succeeding,
 please describe it below in as much detail as possible.
 
@@ -43,7 +43,7 @@ configuration snippets and commands.
 ### Proposal
 <!---
 If you have an idea for a way to address the problem via a change to
-terraform-plugin-log, please describe it below.
+terraform-plugin-testing, please describe it below.
 
 In this section, it's helpful to include specific examples of how what you are
 suggesting might look like in configuration files, on the command line, or in

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 version: 2
 updates:
   - package-ecosystem: "github-actions"

.github/dependabot.yml

@@ -1,9 +1,16 @@
 name: release
 
 on:
-  push:
-    tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+*'
+  workflow_dispatch:
+    inputs:
+      versionNumber:
+        description: 'Release version number'
+        type: string
+        required: true
+
+env:
+  CI_COMMIT_AUTHOR: hc-github-team-tf-provider-devex
+  CI_COMMIT_EMAIL: [email protected]
 
 permissions:
   # Allow creating GitHub release
@@ -12,21 +19,74 @@ permissions:
   issues: write
 
 jobs:
+  changelog-version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.changelog-version.outputs.version }}
+    steps:
+      - id: changelog-version
+        run: echo "version=$(echo "${{ inputs.versionNumber }}" | cut -c 2-)" >> "$GITHUB_OUTPUT"
+  changelog:
+    needs: changelog-version
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Batch changes
+        uses: miniscruff/changie-action@v0
+        with:
+          version: latest
+          args: batch ${{ needs.changelog-version.outputs.version }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Merge changes
+        uses: miniscruff/changie-action@v0
+        with:
+          version: latest
+          args: merge
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Git push changelog
+        run: |
+          git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
+          git config --global user.email "${{ env.CI_COMMIT_EMAIL }}"
+          git add .
+          git commit -a -m "Update changelog"
+          git push
+  release-tag:
+    needs: changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Git push release tag
+        run: |
+          git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
+          git config --global user.email "${{ env.CI_COMMIT_EMAIL }}"
+          git pull
+          git tag "${{ inputs.versionNumber }}"
+          git push origin "${{ inputs.versionNumber }}"
   goreleaser:
+    needs: [ changelog-version, changelog, release-tag ]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
         with:
-          # Required for release notes
+          ref: ${{ inputs.versionNumber }}
           fetch-depth: 0
       - uses: actions/setup-go@v3
         with:
           go-version-file: 'go.mod'
       - name: Generate Release Notes
-        # Fetch CHANGELOG.md contents up to Git tag prior to this release, skipping top two lines
-        run: sed -n -e "1{/# /d;}" -e "2{/^$/d;}" -e "/# $(git describe --abbrev=0 --exclude="$(git describe --abbrev=0 --match='v*.*.*' --tags)" --match='v*.*.*' --tags | tr -d v)/q;p" CHANGELOG.md > /tmp/release-notes.txt
+        run: |
+          cd .changes
+          sed -e "1{/# /d;}" -e "2{/^$/d;}" ${{ needs.changelog-version.outputs.version }}.md > /tmp/release-notes.txt
       - uses: goreleaser/goreleaser-action@v4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          args: release --release-notes /tmp/release-notes.txt --rm-dist
+          args: release --release-notes /tmp/release-notes.txt --rm-dist

.github/workflows/release.yml

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
+and is generated by [Changie](https://github.com/miniscruff/changie).
+
+
+No releases yet, this file will be updated when generating your first release.