Skip to content

pkg: Add script to check third party package version#20662

Merged
maribu merged 1 commit intoRIOT-OS:masterfrom
namberino:pkg-makefile_version_check
May 27, 2024
Merged

pkg: Add script to check third party package version#20662
maribu merged 1 commit intoRIOT-OS:masterfrom
namberino:pkg-makefile_version_check

Conversation

@namberino
Copy link
Copy Markdown
Contributor

@namberino namberino commented May 10, 2024

Contribution description

This provides a script that will read the Makefile of third party packages in the pkg/ directory and compare the PKG_VERSION hash with the latest upstream release hash or commit hash and check if the package is outdated or not.

The script requires a GitHub API token to run.

Testing procedure

Running the script and inputing a GitHub API token should print out a list of outdated packages.

Issues/PRs references

Fixes #13911

@github-actions github-actions bot added the Area: pkg Area: External package ports label May 10, 2024
@benpicco benpicco requested review from chrysn and miri64 May 13, 2024 09:27
mguetschow
mguetschow requested changes May 15, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@mguetschow mguetschow left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks, that seems to be a nice addition!

From a very quick glance at the changes, already some comments:

  • could you adapt the script to follow our python coding convention? In particular, provide and use a main function (also move initialization code there), add a copyright notice and shorten lines longer than 120 chars.
  • could you move the script under dist/tools/pkg_version_check (or similar) and provide a (short) README explaining its function?

mguetschow
mguetschow reviewed May 15, 2024
View reviewed changes
@mguetschow
Copy link
Copy Markdown
Contributor

mguetschow commented May 15, 2024

Tried it locally, the python file is missing the executable rights (chmod u+x version_check.py).

Total number of outdated packages: 74

👀

I think it would be nice to provide more concise output, only listing failures and outdated packages.

@namberino namberino requested a review from jia200x as a code owner May 18, 2024 12:41
@github-actions github-actions bot added Area: doc Area: Documentation Area: tools Area: Supplementary tools and removed Area: pkg Area: External package ports labels May 18, 2024
@namberino namberino requested a review from mguetschow May 18, 2024 12:42
@namberino
Copy link
Copy Markdown
Contributor Author

namberino commented May 24, 2024

I've moved the script to dist/tools and reformatted the output so that it will only print out the outdated and failed packages. I've also added a README for this script and rewrote the script to follow RIOT's coding convention

mguetschow
mguetschow requested changes May 24, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

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

Thanks, looks mostly good to me. Below just some suggestions and minor nits.

@namberino
Copy link
Copy Markdown
Contributor Author

namberino commented May 24, 2024 •
edited
Loading

Thanks for the suggestions, I've updated the script and the README

@namberino namberino requested a review from mguetschow May 24, 2024 15:14
@mguetschow mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label May 24, 2024
@riot-ci
Copy link
Copy Markdown

riot-ci commented May 24, 2024 •
edited
Loading

Murdock results

✔️ PASSED

0c49709 dist/tools: Add pkg version check script

Success Failures Total Runtime
1 0 1 01m:12s

Artifacts

mguetschow
mguetschow reviewed May 24, 2024
View reviewed changes
@namberino namberino requested a review from mguetschow May 24, 2024 15:39
mguetschow
mguetschow approved these changes May 24, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

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

LGTM then! Please squash your commits together into a single one.

@namberino namberino closed this May 24, 2024
@namberino namberino force-pushed the pkg-makefile_version_check branch from 90846ae to 3927a4f Compare May 24, 2024 16:31
@namberino namberino reopened this May 24, 2024
@github-actions github-actions bot added the Area: examples Area: Example Applications label May 24, 2024
@namberino
Copy link
Copy Markdown
Contributor Author

namberino commented May 24, 2024

Sorry for closing the request, I accidentally rebased.

@namberino namberino force-pushed the pkg-makefile_version_check branch from 0be9c2d to 2c1f413 Compare May 24, 2024 16:44
@namberino
Copy link
Copy Markdown
Contributor Author

namberino commented May 24, 2024

Should be good now.

maribu
maribu reviewed May 24, 2024
View reviewed changes
@github-actions github-actions bot removed the Area: examples Area: Example Applications label May 25, 2024
@namberino namberino force-pushed the pkg-makefile_version_check branch from 402658b to 0c49709 Compare May 25, 2024 02:37
@maribu maribu enabled auto-merge May 25, 2024 07:01
@maribu maribu added this pull request to the merge queue May 27, 2024
Merged via the queue into RIOT-OS:master with commit bf3392b May 27, 2024
@mguetschow mguetschow added this to the Release 2024.07 milestone Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maribu maribu maribu left review comments

@mguetschow mguetschow mguetschow approved these changes

@chrysn chrysn Awaiting requested review from chrysn

@miri64 miri64 Awaiting requested review from miri64

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees

No one assigned

Labels

Area: doc Area: Documentation Area: tools Area: Supplementary tools CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Script to check if packages are up to date

4 participants

@namberino @mguetschow @riot-ci @maribu