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 libmem-config.cmake #158

Merged
merged 1 commit into from
Dec 10, 2023
Merged

Add libmem-config.cmake #158

merged 1 commit into from
Dec 10, 2023

Conversation

nathan818fr
Copy link
Contributor

@nathan818fr nathan818fr commented Dec 10, 2023

Following discussions on discord, I'm adding libmem-config.cmake.

Suggesting its use via FetchContent implies carefully maintaining its compatibility over time and not introducing breaking changes.
I suggest creating a dedicated tag, named config-v1 that would track non-breaking updates of this config file.
In this case, the suggested config URL would be: https://raw.githubusercontent.com/rdbo/libmem/config-v1/libmem-config.cmake (instead of relying on the master branch with: https://raw.githubusercontent.com/rdbo/libmem/master/libmem-config.cmake).
And if we ever had to do a breaking change, the config-v1 tag would be frozen, in favor of config-v2, etc.

Also, a version is mentioned in the file (Config version: 2023-12-10.0).
I think this is important because some people will make a copy of the config rather than using FetchContent.
In this case, this will at least let know which exact version was used.

I'm ready to make changes if requested.


To update an existing tag without affecting other tags: git tag -f config-v1 && git push -f origin config-v1
I mention this because it is often suggested to use git push -f --tags, which can be problematic if other tags have been modified locally.

@rdbo rdbo merged commit e6b0142 into rdbo:master Dec 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants