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

Add version check to CI #497

Closed
gavv opened this issue Dec 26, 2022 · 4 comments
Closed

Add version check to CI #497

gavv opened this issue Dec 26, 2022 · 4 comments
Assignees
Labels
continuous integration Continuous integration easy hacks The solution is expected to be straightforward even if you are new to the project help wanted An important and awaited task but we have no human resources for it yet
Milestone

Comments

@gavv
Copy link
Member

gavv commented Dec 26, 2022

We already have CI check that the code is properly formatted: check-formatting.sh.

It would be nice to add check-version.sh, which would verify that version declared in src/public_api/include/roc/version.h is similar as the latest git tag reported by git describe --tags --abbrev=0.

This check should be run only when running CI build for tags that match v*.

We already have a script to parse version from header, which we can use in this check: scripts/scons_helpers/parse-version.py.

Github workflow is here: https://github.com/roc-streaming/roc-toolkit/blob/master/.github/workflows/build.yml

@gavv gavv added help wanted An important and awaited task but we have no human resources for it yet easy hacks The solution is expected to be straightforward even if you are new to the project continuous integration Continuous integration labels Dec 26, 2022
@dheerajd5
Copy link
Contributor

Hey, can I work on this issue?

@gavv
Copy link
Member Author

gavv commented Aug 16, 2023

You're welcome, thanks!

@dheerajd5
Copy link
Contributor

dheerajd5 commented Aug 18, 2023

Hey so my code it isn't passing the android29-x86_64/macos tests, I noticed that these tests also failed on the last build workflow run on the main repo, so I was thinking maybe it didn't have anything to do with the changes I made.
Other than that, it is passing all the checks.
I created a new check- version-check which does the required functionality.

I had to fetch all the tags manually, so it could affect workflow times a bit, I wasn't able to find a workaround to this, when I try to fetch tags through checkout, it doesn't show up.

Here is my workflow run. Link to workflow
Also I'm new to contributing, so in the future, do I mention these things here itself or in my PR?

Edit:
It has passed all checks. I have put a PR.

@gavv
Copy link
Member Author

gavv commented Sep 21, 2023

Landed!

@gavv gavv closed this as completed Sep 21, 2023
@gavv gavv added this to the next milestone Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
continuous integration Continuous integration easy hacks The solution is expected to be straightforward even if you are new to the project help wanted An important and awaited task but we have no human resources for it yet
Projects
Status: Done
Development

No branches or pull requests

2 participants