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

chore: Refactored tooling for best practices #2193

Merged
merged 2 commits into from
Apr 1, 2024

Conversation

stevehipwell
Copy link
Contributor

This PR refactors the provider tooling to align it to GitHub Actions best practices and TF provider best practices. The following things have changed, but there shouldn't be a material change in how the project works.

  • Fixed all GitHub Actions to a SHA with the version in a comment so Dependabot can keep them up to date but the runs are idempotent (to the checked in code)
  • Added Dependabot group support to make GitHub Actions & Go module dependency changes easier to manage when they're not major versions
  • Updated the setup Go GH action to use the Go version in go.mod instead of needing to copy the current version throughout the codebase.
  • Added a terraform-registry-manifest.json file as per best practices
  • Updated the golangci-lint config to the recommended pattern
  • Commented out failing linting rules in .golangci.yml
  • Updated the goreleaser config

Copy link
Member

@kfcampbell kfcampbell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate the attention paid to the details here. I had a first pass of questions/comments.

.github/workflows/release.yml Show resolved Hide resolved
.github/workflows/release.yml Show resolved Hide resolved
.github/workflows/release.yml Show resolved Hide resolved
.goreleaser.yml Show resolved Hide resolved
@stevehipwell
Copy link
Contributor Author

@kfcampbell I've replied to your questions.

Copy link
Member

@kfcampbell kfcampbell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had one final question, thank you for your patience here.

Comment on lines +9 to +11
update-types:
- minor
- patch
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not include major version updates here and below? Shouldn't the PR fire so we're aware the update exists even if we don't want to take it immediately?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this config major version updates will be managed in individual PRs while minor and patch updates will be grouped in a single PR per ecosystem.

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>
@stevehipwell
Copy link
Contributor Author

@kfcampbell I've rebased this ready to be merged.

@kfcampbell kfcampbell merged commit 9a6875d into integrations:main Apr 1, 2024
3 checks passed
@stevehipwell stevehipwell deleted the tooling-refactor branch April 2, 2024 13:17
kireque pushed a commit to kireque/home-ops that referenced this pull request Jun 18, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [github](https://registry.terraform.io/providers/integrations/github)
([source](https://togithub.com/integrations/terraform-provider-github))
| required_provider | patch | `6.2.1` -> `6.2.2` |

---

### Release Notes

<details>
<summary>integrations/terraform-provider-github (github)</summary>

###
[`v6.2.2`](https://togithub.com/integrations/terraform-provider-github/releases/tag/v6.2.2)

[Compare
Source](https://togithub.com/integrations/terraform-provider-github/compare/v6.2.1...v6.2.2)

<!-- Release notes generated using configuration in .github/release.yml
at main -->

#### What's Changed

##### 🛠️ Maintenance

- build(deps): bump actions/add-to-project from 0.6.1 to 1.0.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2215
- build(deps): bump github.com/golangci/golangci-lint from 1.57.1 to
1.57.2 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2216
- build(deps): bump the github-actions group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2218
- build(deps): bump github/codeql-action from 3.24.9 to 3.24.10 in the
github-actions group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2221
- build(deps): bump the gomod group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2220
- build(deps): bump actions/add-to-project from 1.0.0 to 1.0.1 in the
github-actions group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2231
- build(deps): bump golang.org/x/net from 0.22.0 to 0.23.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2234
- build(deps): bump the github-actions group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2238
- build(deps): bump the github-actions group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2244
- build(deps): bump the gomod group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2257
- build(deps): bump actions/setup-go from 5.0.0 to 5.0.1 in the
github-actions group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2256
- build(deps): bump the github-actions group with 3 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2259
- build(deps): bump the gomod group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2260
- build(deps): bump the github-actions group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2268
- build(deps): bump github/codeql-action from 3.25.5 to 3.25.6 in the
github-actions group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2272
- build(deps): bump the gomod group across 1 directory with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2271
- 🚧 Workflows have changed by
[@&#8203;octokitbot](https://togithub.com/octokitbot) in
[integrations/terraform-provider-github#2281
- build(deps): bump the gomod group with 3 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2287
- build(deps): bump github/codeql-action from 3.25.6 to 3.25.8 in the
github-actions group across 1 directory by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2286
- build(deps): bump the github-actions group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2292
- build(deps): bump goreleaser/goreleaser-action from 5.1.0 to 6.0.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[integrations/terraform-provider-github#2293

##### 🏷 Other Changes

- chore: Refactored tooling for best practices by
[@&#8203;stevehipwell](https://togithub.com/stevehipwell) in
[integrations/terraform-provider-github#2193
- changed logic on repositories_detailed by
[@&#8203;n47h4n12](https://togithub.com/n47h4n12) in
[integrations/terraform-provider-github#2248
- improve documentation for `github_repository` by
[@&#8203;garysassano](https://togithub.com/garysassano) in
[integrations/terraform-provider-github#2265
- docs: update title and code highlighting for github_repository_ruleset
by [@&#8203;stefanfreitag](https://togithub.com/stefanfreitag) in
[integrations/terraform-provider-github#2285
- docs: add missing quote in branch protection v3 example by
[@&#8203;stefanfreitag](https://togithub.com/stefanfreitag) in
[integrations/terraform-provider-github#2283
- Goreleaser deprecation: skip --> disable by
[@&#8203;kfcampbell](https://togithub.com/kfcampbell) in
[integrations/terraform-provider-github#2294

#### New Contributors

- [@&#8203;stevehipwell](https://togithub.com/stevehipwell) made their
first contribution in
[integrations/terraform-provider-github#2193
- [@&#8203;n47h4n12](https://togithub.com/n47h4n12) made their first
contribution in
[integrations/terraform-provider-github#2248
- [@&#8203;garysassano](https://togithub.com/garysassano) made their
first contribution in
[integrations/terraform-provider-github#2265
- [@&#8203;stefanfreitag](https://togithub.com/stefanfreitag) made their
first contribution in
[integrations/terraform-provider-github#2285

**Full Changelog**:
integrations/terraform-provider-github@v6.2.1...v6.2.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MTAuMiIsInVwZGF0ZWRJblZlciI6IjM3LjQxMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJyZW5vdmF0ZS90ZXJyYWZvcm0iLCJ0eXBlL3BhdGNoIl19-->

Co-authored-by: kireque-bot[bot] <143391978+kireque-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants