microsoft / microsoft/AzureTRE

Improve Wording of Lint Checker

Open
#4,432 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

story
Dominant language
Python
Stars
235
Forks
192
Avg merge
1d 23h
Merged PRs (30d)
13

Description

Currently the lint checker checks for version increments when code has changed, the error wording reads: Code update without version change. This gives little help as to which version file needs to be incremented.

This could be changed to read Code has been updated without a version change. Check the current version of file [version.txt|_version.py] in main and ensure you have incremented the version

This would make it easier for new contributors to the repo to understand which versions need bumping when they've made changes.
Links to files below:
build_docker_images.yml
(https://github.com/microsoft/AzureTRE/blob/6d51070b7cffb9b38219e860bf48c9450dfc9071/.github/workflows/build_docker_images.yml#L67)
(https://github.com/microsoft/AzureTRE/blob/6d51070b7cffb9b38219e860bf48c9450dfc9071/.github/workflows/build_docker_images.yml#L72)
(https://github.com/microsoft/AzureTRE/blob/6d51070b7cffb9b38219e860bf48c9450dfc9071/.github/workflows/build_docker_images.yml#L77)
(https://github.com/microsoft/AzureTRE/blob/6d51070b7cffb9b38219e860bf48c9450dfc9071/.github/workflows/build_docker_images.yml#L82)
(https://github.com/microsoft/AzureTRE/blob/6d51070b7cffb9b38219e860bf48c9450dfc9071/.github/workflows/build_docker_images.yml#L87)
(https://github.com/microsoft/AzureTRE/blob/6d51070b7cffb9b38219e860bf48c9450dfc9071/.github/workflows/build_docker_images.yml#L92),
build_validation_develop.yml
(https://github.com/microsoft/AzureTRE/blob/6d51070b7cffb9b38219e860bf48c9450dfc9071/.github/workflows/build_validation_develop.yml#L81)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the lint-checker steps linked in .github/workflows/build_docker_images.yml and .github/workflows/build_validation_develop.yml, then locate the code that emits “Code update without version change.” Update the message to identify version.txt and _version.py and explain the required increment; done means the checker reports the clearer wording when code changes without a version bump.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.