Closed JoeWang1127 closed 1 day ago
I know we said that it's OK to not support running scripts directly. What is the effort to support it? Do we need to write additional code or just need to set
DOCKER_PROTOC_VERSION
andDOCKER_GRPC_VERSION
?
I think we need to download the the protoc/grpc and put them into a well-known location, just like the generator and formatter jar.
- Remove instructions on running python script in local environment because the current setup will fail if
DOCKER_PROTOC_VERSION
orDOCKER_GRPC_VERSION
is not set.
We don't write any additional code to support running the scripts directly.
- Remove instructions on running python script in local environment because the current setup will fail if
DOCKER_PROTOC_VERSION
orDOCKER_GRPC_VERSION
is not set.
@JoeWang1127 why not just explain the developer that these variables must be set?
I think we need to download the the protoc/grpc and put them into a well-known location, just like the generator and formatter jar
Cool, if that's the case, maybe we can continue to support it by adding a few documentation to DEVELOPMENT.md? Feel free to not do it if you think there is not much use case for it anyway and it's not worth the effort.
@JoeWang1127 why not just explain the developer that these variables must be set?
I don't think it's intuitive to set these environment variables only for running the script directly.
The variable name is clearly indicating running in docker container, why setting these env if we're using python script?
@JoeWang1127 why not just explain the developer that these variables must be set?
I don't think it's intuitive to set these environment variables only for running the script directly.
The variable name is clearly indicating running in docker container, why setting these env if we're using python script?
I agree it's not intuitive. However, these variables are automatically set when building the image, so we must set them always, although manually for the case of local development.
I remember we used the DOCKER_
prefix was used to distinguish the variables from what's in the config file, but we are not using these config entries in the yaml since this PR. Maybe we can drop the prefix and rename them to PROTOC_LOCATION
? edit: this can be a follow up
Cool, if that's the case, maybe we can continue to support it by adding a few documentation to DEVELOPMENT.md? Feel free to not do it if you think there is not much use case for it anyway and it's not worth the effort.
I think we can create another pr to support the directly run. I feel it's too much for this PR.
I remember we used the
DOCKER_ prefix
was used to distinguish the variables from what's in the config file, but we are not using these config entries in the yaml since this PR. Maybe we can drop the prefix and rename them to PROTOC_LOCATION? edit: this can be a follow up
SGTM.
I decided to keep the support of running python script directly in development guide.
Issues
0 New issues
0 Accepted issues
Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code
Issues
0 New issues
0 Accepted issues
Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code
In this PR:
protoc_version
andgrpc_version
from generation config.