l50 / goutils / 8873588670

88%

Build Type

push

github

Committed by web-flow

Commit Message

Magefile now uses project deps; fixed docs overwriting repo README (#644)

### Summary of Changes

This pull request introduces a series of refactors and updates to our project's repository, aimed at streamlining configurations and improving the codebase structure. Here are the detailed changes from the commits included in this PR:

#### Refactor and Removal of the `magefiles` Directory
- **Enhanced Error Handling**: Introduced better error handling in `mageutils_test` to ensure repository root access is verified.
- **Streamlined Pre-commit Actions**: Centralized `go mod tidy` commands to simplify pre-commit actions.
- **Updated go-vet.sh**: Adjusted the script to exclude `magefiles` from the vetting process.
- **Visual Studio Code Configurations**: Updated to reflect new file locations.
- **GitHub Workflow Adjustments**: Modified to commit only the relevant `go.mod` and `go.sum` files.
- **Removals**:
  - Removed `area/magefiles` from GitHub labeler and labels configurations.
  - Deleted outdated configurations and references to the `magefiles` directory in various scripts and tests.

#### Repository Structure Enhancements
- **Added gitutils Import**: Improved path resolution by adding `gitutils` import to `lintutils`.
- **Refactored Codebase**:
  - Simplified `codespell` skip paths in `.pre-commit-config.yaml`.
  - Utilized `gitutils.RepoRoot` for consistent path handling across the project.
  - Updated tests to use a new template directory instead of `magefiles`.
  - Streamlined dependency management in `magefile.go`.
  - Adapted `sysutils_test` to a new temporary directory prefix.
- **Removed**:
  - Outdated test cases and unused code sections related to the `magefiles` directory.

#### Minor Updates
- **Updated `generateReadmeFromTemplate`**: Ensured that the repository README isn't accidentally overwritten.
- **Infrastructure Changes**:
  - Moved `magefile` repository root.
  - Created a new `templates` directory to ... (continued)

Run Details

3 of 20 new or added lines in 2 files covered. (15.0%)

120 existing lines in 2 files now uncovered.

1583 of 2646 relevant lines covered (59.83%)

10.59 hits per line