Inject module's version #41
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Totktonada
reviewed
Jan 21, 2022
no1seman
force-pushed
the
specify_version
branch
from
174cf00 to
d91d645
Compare
Totktonada
approved these changes
Jan 21, 2022
Closed
Totktonada
added a commit
that referenced
this pull request
Apr 8, 2022
XXX: luarocks removes `.git` directory after cloning a repository. So
actually this approach only works when we're within our cloned
repository. So, questions:
1. We need to reprase comments acoordingly at least.
2. Whether it works with tarantoolctl rocks install in CI?
Now it is possible to obtain a version of the module using the
following code:
```lua
local graphql = require('graphql')
print(graphql.VERSION)
```
It does not work for cloned repository (without calling `tarantoolctl
rocks make`) -- the `graphql.VERSION` field will return `'unknown'`, but
it works for a user scenario: when the module is installed either from
.all.rock file or from the rockspec.
The short list of changes is the following.
- Upload all.rock instead of .src.rock for releases. I don't find a way
to add a generated file into the .src.rock tarball using luarocks. It
is not necessary, though: it is completely okay (and even preferable)
to ship .all.rock for a pure Lua module.
- Upload scm-1 rockspec from CI.
- Moved from the `'builtin'` build type to `'make'` in the rockspec to
generate the `graphql/VERSION.lua` file at the build stage.
- Added Make targets for luarocks with `graphql/VERSION.lua` file
generation.
- Added `graphql/init.lua` file with `VERSION` field, which is filled
from the generated `graphql/VERSION.lua` file if it is present.
Otherwise it is filled with the `'unknown'` string.
And a couple of minor tweaks:
- Replaced `tarantoolctl rocks new_version --tag $TAG` with `sed` in the
rockspec publication workflow, because the former strips comments and
reformats the file. It is a thing of taste: personally I prefer to be
able to diff rockspecs on the rock server in case of an incident.
- Use `ubuntu-latest` in rockspec publication workflow, because we have
nothing Ubuntu version specific here. This way it requires less
maintenance.
The publication workflow now almost the same as in expirationd, see [1].
As for me, it is good to have such code standartized.
This is reimplementation of the original #29 fix from PR #41. The key
points are the following.
- Usage the `'make'` build type allows to lower the logic down to
luarocks level, so it works not only from CI.
- Complete the implementation by packing into .all.rock instead of
.src.rock. Otherwise it does not work at all, see [2] for details.
- Generate the gitignored `graphql/VERSION.lua` file (don't touch
`graphql/init.lua`) to don't leave the repository clone in a dirty
state.
Also it is the alternative to PR #50, where the `'cmake'` build type was
proposed for the same purposes. The differences are the following.
- Use Make instead of CMake for the same of simplicity.
- Don't require tarantool-dev/devel package for building the rock or
installing the package from the rockspec.
[1]: tarantool/expirationd#55
[2]: #46 (comment)
Follows up #29
Supersedes PR #50
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Inject modules version to make possible identify version of this particular module in runtime
closes: #29