feat: standardize acceptance tests, clean up docs, and implement test workflows#8
Merged
feat: standardize acceptance tests, clean up docs, and implement test workflows#8
Conversation
Replace the Makefile with a Taskfile for improved task management and developer experience. Update documentation to reference Taskfile usage, add installation instructions for go-task, and update Homebrew dependencies. Adjust provider binary build and test instructions. Update docs metadata and main.go to support debugging and provider address configuration.
- Introduce `.github/workflows/test.yaml` for CI, running build, docs, and acceptance tests on PRs and pushes to main. - Update Taskfile `sweep` command to use correct sweep target. - Update docs to use "forwardemail Provider" naming and clarify schema section as "Optional". - Fix provider test to avoid unused variable warning. - Improve sweeper comment for domain resource tests.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Makefilewith aTaskfile.yml, improving testing and linting infrastructure, and updating documentation and code for best practices and compatibility.What
Development Workflow Modernization:
Makefileand introduced a newTaskfile.ymlthat defines tasks for building, testing, linting, formatting, documentation generation, and installation, making local development and CI setup more consistent and easier to maintain. [1] [2]README.mdto reference Taskfile-based workflows, including installation instructions and new build/test commands, and removed outdated test instructions. [1] [2] [3]Brewfilefor local development (go-task,golangci-lint).Continuous Integration and Testing Improvements:
.github/workflows/test.yaml) that builds, tests, checks documentation, and runs acceptance tests across multiple Terraform versions.terraform-plugin-testingframework, improved acceptance test gating, and added plan restriction checks for smoother CI runs. [1] [2] [3]Linting and Formatting Enhancements:
.golangci.ymlto enable a broader set of linters, configure linter options, and integrate with the new workflow, raising code quality standards..editorconfigto clarify line endings and Go tab/indentation settings.Documentation and Code Quality:
interface{}withanyand improving doc comments and package headers. [1] [2] [3] [4]These changes collectively bring the project up to modern standards, making it easier to develop, test, and contribute.
References: [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]