Skip to content

Commit 297c8da

Browse files
committed
Remove obsolete instructions re: setting framework versions in workflows
Some GitHub Actions workflows must install the appropriate version of Go and Python. Previously the version was configured in the workflow, and so the template installation documentation included instructions for setting the project's version of the framework in the workflow. A new approach is now used to get Go and Python versioning information from a single source in the configuration file, so there is no longer any version configuration in the workflow, rendering those instructions obsolete. The instructions were not removed at the time the workflows were migrated to the new system.
1 parent 9b20249 commit 297c8da

7 files changed

+0
-21
lines changed

workflow-templates/check-go-task.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ Install the [`check-go-task.yml`](check-go-task.yml) GitHub Actions workflow to
1919

2020
### Configuration
2121

22-
Configure the version of Go used for development of the project in the `env.GO_VERSION` field of `check-go-task.yml`.
23-
2422
If the project contains Go modules in paths other than the root of the repository, add their paths to the [job matrices](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) of `check-go-task.yml` at:
2523

2624
- `jobs.check-errors.strategy.matrix.module[].path`

workflow-templates/check-python-task.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,6 @@ Commit the resulting `pyproject.toml` and `poetry.lock` files.
4545

4646
### Configuration
4747

48-
#### Workflow
49-
50-
Set the version of Python used by the project in the `env.PYTHON_VERSION` field of `check-python-task.yml`.
51-
5248
#### black
5349

5450
Add the following to `pyproject.toml`:

workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ See the ["Deploy Website" workflow (versioned, MkDocs, Poetry) documentation](de
3838

3939
#### Workflow
4040

41-
Configure the version of Go used for development of the project in the `env.GO_VERSION` field of `deploy-cobra-mkdocs-versioned-poetry.yml`.
42-
4341
#### Taskfile
4442

4543
Set the `PROJECT_NAME` variable to the project name.

workflow-templates/release-go-crosscompile-task.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ The following project-specific variables must be set/configured in `release-go-c
3535

3636
- `PROJECT_NAME`
3737
- `AWS_PLUGIN_TARGET`
38-
- `GO_VERSION`: version of Go used for development of the project, use at least [GO 1.16 to be able to use 64-bit ARM architecture on macOS](https://tip.golang.org/doc/go1.16#ports)
3938

4039
#### AWS IAM Role
4140

workflow-templates/test-go-integration-task.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,6 @@ Commit the resulting `pyproject.toml` and `poetry.lock` files.
4949

5050
### Configuration
5151

52-
#### Workflow
53-
54-
Configure the version of Go used for development of the project in the `env.GO_VERSION` field of `test-go-integration-task.yml`.
55-
56-
Configure the version of Python used for development of the project in the `env.PYTHON_VERSION` field of `test-go-integration-task.yml`.
57-
5852
#### Test helpers
5953

6054
Define the project's executable filename in the `executable_path` variable in `test_all.py`.

workflow-templates/test-go-task.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ Install the [`test-go-task.yml`](test-go-task.yml) GitHub Actions workflow to `.
2121

2222
#### Workflow
2323

24-
Configure the version of Go used for development of the project in the `env.GO_VERSION` field of `test-go-task.yml`.
25-
2624
If the project contains Go modules in paths other than the root of the repository, add their paths to the [job matrix](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) in `check-go-task.yml` at `jobs.test.strategy.matrix.module[].path` and the [Codecov flag](https://docs.codecov.com/docs/flags) to group their data under at `jobs.test.strategy.matrix.module[].codecov-flags`
2725

2826
Replace `TODO_REPO_OWNER/TODO_REPO_NAME` with the repository's name (e.g., `arduino/arduino-cli`) in the `codecov/codecov-action` action's `fail_ci_if_error` input in `test-go-task.yml`.

workflow-templates/test-python-poetry-task.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,6 @@ poetry add --dev "pytest@^8.4.1"
4545

4646
Commit the resulting `pyproject.toml` and `poetry.lock` files.
4747

48-
### Configuration
49-
50-
Configure the version of Python used for development of the project in the `env.PYTHON_VERSION` field of `test-go-integration-task.yml`.
51-
5248
### Readme badge
5349

5450
Markdown badge:

0 commit comments

Comments
 (0)