Skip to content

Commit

Permalink
CONTRIBUTING.md rework (#1888)
Browse files Browse the repository at this point in the history
* Minor edits to first section of README

* Unify disparate Go versions across docs and workflows to Go 1.21

* Wrap up CONTRIBUTING.md rework

* Give example .vscode/launch.json file

* Try rendering YAML to avoid ugly comments

* Swap back to JSON

* Add major version release documentation
  • Loading branch information
kfcampbell authored Sep 13, 2023
1 parent cec7e17 commit cf4cb55
Show file tree
Hide file tree
Showing 11 changed files with 130 additions and 94 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-go@v4
with:
go-version: '1.20.2'
go-version: '1.21'
- run: make tools
- run: make lint
- run: make website-lint
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v4
- uses: actions/setup-go@v4
with:
go-version: '1.21'

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/dotcom-acceptance-tests-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Anonymous)
uses: terraformtesting/[email protected]
with:
Expand All @@ -34,6 +37,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'

- name: Acceptance Tests (Individual)
id: acceptance-tests-individual
Expand Down Expand Up @@ -63,6 +69,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'

- name: Acceptance Tests (Organization)
id: acceptance-tests-organization
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/dotcom-acceptance-tests-manual.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ jobs:
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Anonymous)
id: acceptance-tests-anonymous
uses: terraformtesting/[email protected]
Expand Down Expand Up @@ -48,6 +51,9 @@ jobs:
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Individual)
id: acceptance-tests-individual
uses: terraformtesting/[email protected]
Expand Down Expand Up @@ -81,6 +87,9 @@ jobs:
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
- uses: actions/setup-go@v4
with:
go-version: '1.21'

- name: Acceptance Tests (Organization)
id: acceptance-tests-organization
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/dotcom-acceptance-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Individual)
uses: terraformtesting/[email protected]
with:
Expand All @@ -44,6 +47,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Organization)
uses: terraformtesting/[email protected]
with:
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/ghes-acceptance-tests-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Anonymous)
uses: terraformtesting/[email protected]
with:
Expand All @@ -47,6 +50,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'

- name: Acceptance Tests (Individual)
id: acceptance-tests-individual
Expand Down Expand Up @@ -78,6 +84,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'

- name: Acceptance Tests (Organization)
id: acceptance-tests-organization
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/ghes-acceptance-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Anonymous)
uses: terraformtesting/[email protected]
with:
Expand All @@ -42,6 +45,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Individual)
uses: terraformtesting/[email protected]
with:
Expand All @@ -59,6 +65,9 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 2
- uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Acceptance Tests (Organization)
uses: terraformtesting/[email protected]
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
name: Set up Go
uses: actions/setup-go@v4
with:
go-version: 1.18
go-version: 1.21
-
name: Import GPG key
id: import_gpg
Expand Down
Loading

0 comments on commit cf4cb55

Please sign in to comment.