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

tools/update-meson.py is too undiscoverable #39172

Closed
user202729 opened this issue Dec 19, 2024 · 0 comments · Fixed by #39527
Closed

tools/update-meson.py is too undiscoverable #39172

user202729 opened this issue Dec 19, 2024 · 0 comments · Fixed by #39527

Comments

@user202729
Copy link
Contributor

user202729 commented Dec 19, 2024

Problem Description

As in the title. It leads to unnecessarily too many confusion ( #39159 #39046 (comment) )

Proposed Solution

I suggest the following

  • the meson GitHub CI action automatically runs the script before building, then gives a failure if git diff returns nonzero diff (but proceed with the build and test anyway to save time)
  • pre-commit hook?
  • at the head of each meson.build file, say "this file is autogenerated" etc. (or only "mostly autogenerated"? I don't know)

Maybe @tobiasdiez is the best one to do this. (I'm not entirely sure how to use the script either (just run it?), or is it supposed to be fully automatic)

vbraun pushed a commit to vbraun/sage that referenced this issue Feb 21, 2025
sagemathgh-39527: Test on CI that update-meson is properly ran
    
Fixes sagemath#39172


Side note, can we just include the `__init__.py` to be tracked by git?

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [x] I have created tests covering the changes. (not applicable)
- [x] I have updated the documentation and checked the documentation
preview. (no documentation change? Do we need to mention this in
developer guide somewhere?)

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#39527
Reported by: user202729
Reviewer(s): Tobias Diez, user202729
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant