Skip to content

Commit

Permalink
chore: add delay for docker tools, doc updates
Browse files Browse the repository at this point in the history
Added slight delay in tools for docker commands to avoid a harmless but unnecessary error message.
Corrected codecov badge in README.
Stated a new file CONTRIBUTING.md with development specific notes.
  • Loading branch information
tanmaykm committed Jul 26, 2024
1 parent 7323f20 commit 1420490
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Guidelines For Contributing

### Updating the code generator

The ["openapi-generator"](https://github.com/OpenAPITools/openapi-generator/) repository contains the code generator for Julia. For any changes that also need updates to the generated code, a PR needs to be made to the `openapi-generator` repo. Relevant files:
- <https://github.com/OpenAPITools/openapi-generator/blob/master/.github/workflows/samples-julia.yaml>
- <https://github.com/OpenAPITools/openapi-generator/tree/master/bin/configs/julia-client-petstore-new.yaml>
- <https://github.com/OpenAPITools/openapi-generator/tree/master/bin/configs/julia-server-petstore-new.yaml>
- <https://github.com/OpenAPITools/openapi-generator/tree/master/samples/client/petstore/julia>
- <https://github.com/OpenAPITools/openapi-generator/tree/master/samples/server/petstore/julia>
- <https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJuliaCodegen.java>
- <https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JuliaServerCodegen.java>
- <https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JuliaClientCodegen.java>
- <https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/julia-client>
- <https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/julia-server>

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OpenAPI

[![Build Status](https://github.com/JuliaComputing/OpenAPI.jl/workflows/CI/badge.svg)](https://github.com/JuliaComputing/OpenAPI.jl/actions?query=workflow%3ACI+branch%3Amain)
[![codecov.io](http://codecov.io/github/JuliaComputing/OpenAPI.jl/coverage.svg?branch=main)](http://codecov.io/github/JuliaComputing/OpenAPI.jl?branch=main)
[![codecov](https://codecov.io/gh/JuliaComputing/OpenAPI.jl/branch/main/graph/badge.svg?token=iZeFL7Js0l)](https://codecov.io/gh/JuliaComputing/OpenAPI.jl)

This is the Julia library needed along with code generated by the [OpenAPI generator](https://openapi-generator.tech/) to help define, produce and consume OpenAPI interfaces.

Expand Down
1 change: 1 addition & 0 deletions src/tools.jl
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ function _stop_docker(image_name::AbstractString, image_type::AbstractString; us
return false
end

sleep(5)
container_id = strip(String(read(find_cmd)))
if !isempty(container_id)
rm_cmd = `$docker rm $container_id`
Expand Down

0 comments on commit 1420490

Please sign in to comment.