consider having a single source of truth for chalk version #138
Assignees
Comments
ee7
added a commit
that referenced
this issue
Jan 19, 2024
ee7
added a commit
that referenced
this issue
Jan 19, 2024
5 tasks
ee7
added a commit
that referenced
this issue
Jan 22, 2024
Before this commit, we had to update the chalk version in two places.
One was in src/configs/base_keyspecs.c4m:
chalk_version := "0.3.1"
And the other in chalk.nimble:
version = "0.3.1"
Historically, this duplication has caused the versions to go out of
sync such that a chalk mark contained an incorrect CHALK_VERSION [1].
The tests in chalk now guard against that [2], but it's still better to
define the version in one place.
Make the keyspecs version the single source of truth, setting the
version in the nimble file from there.
This will also help with making a development version of chalk have a
distinguishable version string from a release version of chalk, if
that's something we deem worthwhile.
Also, refactor to remove the macro that was previously used in setting
the version.
Closes: #138
[1] #28
[2] 2f1b55c, 2023-10-06, "test(lint): adding pre-commit hook for checking chalk version across files"
ee7
added a commit
that referenced
this issue
Jan 22, 2024
Before this commit, we had to update the chalk version in two places.
One was in src/configs/base_keyspecs.c4m:
chalk_version := "0.3.1"
And the other in chalk.nimble:
version = "0.3.1"
Historically, this duplication has caused the versions to go out of
sync such that a chalk mark contained an incorrect CHALK_VERSION [1].
The tests in chalk now guard against that [2], but it's still better to
define the version in one place.
Make the keyspecs version the single source of truth, setting the
version in the nimble file from there.
This will also help with making a development version of chalk have a
distinguishable version string from a release version of chalk, if
that's something we deem worthwhile.
Also, refactor to remove the macro that was previously used in setting
the version.
Closes: #138
[1] #28
[2] 2f1b55c, 2023-10-06, "test(lint): adding pre-commit hook for checking chalk version across files"
ee7
added a commit
that referenced
this issue
Jan 22, 2024
Before this commit, we had to update the chalk version in two places.
One was in src/configs/base_keyspecs.c4m:
chalk_version := "0.3.1"
And the other in chalk.nimble:
version = "0.3.1"
Historically, this duplication has caused the versions to go out of
sync such that a chalk mark contained an incorrect CHALK_VERSION [1].
The tests in chalk now guard against that [2], but it's still better to
define the version in one place.
Make the keyspecs version the single source of truth, setting the
version in the nimble file from there.
This will also help with making a development version of chalk have a
distinguishable version string from a release version of chalk, if
that's something we deem worthwhile.
Also, refactor to remove the macro that was previously used in setting
the version.
Closes: #138
[1] #28
[2] 2f1b55c, 2023-10-06, "test(lint): adding pre-commit hook for checking chalk version across files"
ee7
added a commit
that referenced
this issue
Jan 26, 2024
Before this commit, we had to update the chalk version in two places.
One was in src/configs/base_keyspecs.c4m:
chalk_version := "0.3.1"
And the other in chalk.nimble:
version = "0.3.1"
Historically, this duplication has caused the versions to go out of
sync such that a chalk mark contained an incorrect CHALK_VERSION [1].
The tests in chalk later guarded against that [2], but it's still better
to define the version in one place.
Make the keyspecs version the single source of truth, setting the
version in the nimble file from there.
This will also help with making a development version of chalk have a
distinguishable version string from a release version of chalk, if
that's something we deem worthwhile.
Also, refactor to remove the macro that was previously used in setting
the version.
Closes: #138
[1] #28
[2] 2f1b55c, 2023-10-06, "test(lint): adding pre-commit hook for checking chalk version across files"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
Currently, we have to update the chalk version in two places for every release:
chalk/src/configs/base_keyspecs.c4m
Line 55 in 7a390c8
chalk/chalk.nimble
Line 1 in 7a390c8
Historically, that's caused the versions to go out-of-sync: #28.
Happily, chalk has since received a test to ensure that doesn't happen again (#41), but it's still probably marginally worthwhile to define the version in one place.
We can do that by making the nimble file read
base_keyspecs.c4m.This isn't a high-priority user-facing thing, but it'd also help with making a development version of chalk write a distinguishable
CHALK_VERSIONfrom a release version of chalk, if that's something we deemed worthwhile.Result
A single source of truth for the chalk version, at the cost of a few extra lines and a
staticReadin the nimble file.Dependencies
None.
Subtickets
None.
The text was updated successfully, but these errors were encountered: