bump version to v0.5.2 (#94)

1. polish compile option in `.bazelrc` to hit bazel cache most of the time
2. add pull request template

.bazelrc

@@ -1,9 +1,9 @@
 build --action_env=BAZEL_LINKLIBS=-l%:libstdc++.a:-lm
 build --action_env=BAZEL_LINKOPTS=-static-libgcc
 build --incompatible_strict_action_env --cxxopt=-std=c++17 --host_cxxopt=-std=c++17 --client_env=BAZEL_CXXOPTS=-std=c++17
-build:release --copt=-g0 --copt=-O3 --copt=-DNDEBUG --copt=-msse --copt=-msse2 --copt=-mmmx
 build:debug --cxxopt=-DENVPOOL_TEST --compilation_mode=dbg -s
-build:test --cxxopt=-DENVPOOL_TEST
+build:test --cxxopt=-DENVPOOL_TEST --copt=-g0 --copt=-O3 --copt=-DNDEBUG --copt=-msse --copt=-msse2 --copt=-mmmx
+build:release --copt=-g0 --copt=-O3 --copt=-DNDEBUG --copt=-msse --copt=-msse2 --copt=-mmmx
 
 build:clang-tidy --aspects @bazel_clang_tidy//clang_tidy:clang_tidy.bzl%clang_tidy_aspect
 build:clang-tidy --@bazel_clang_tidy//:clang_tidy_config=//:clang_tidy_config

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,41 @@
+## Description
+
+Describe your changes in detail.
+
+## Motivation and Context
+
+Why is this change required? What problem does it solve?
+If it fixes an open issue, please link to the issue here.
+You can use the syntax `close #233` if this solves the issue #233
+
+- [ ] I have raised an issue to propose this change ([required](https://envpool.readthedocs.io/en/latest/pages/contributing.html) for new features and bug fixes)
+
+## Types of changes
+
+What types of changes does your code introduce? Put an `x` in all the boxes that apply:
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds core functionality)
+- [ ] New environment (non-breaking change which adds 3rd-party environment)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation (update in the documentation)
+- [ ] Example (update in the folder of example)
+
+## Implemented Tasks
+
+- [ ] Subtask 1
+- [ ] Subtask 2
+- [ ] Subtask 3
+
+## Checklist
+
+Go over all the following points, and put an `x` in all the boxes that apply.
+If you are unsure about any of these, don't hesitate to ask. We are here to help!
+
+- [ ] I have read the [CONTRIBUTION](https://envpool.readthedocs.io/en/latest/pages/contributing.html) guide (**required**)
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the tests accordingly (*required for a bug fix or a new feature*).
+- [ ] I have updated the documentation accordingly.
+- [ ] I have reformatted the code using `make format` (**required**)
+- [ ] I have checked the code using `make lint` (**required**)
+- [ ] I have ensured `make bazel-test` pass. (**required**)

.github/workflows/test.yml

@@ -26,4 +26,4 @@ jobs:
         make bazel-test BAZELOPT="--remote_cache=http://bazel-cache.sail:8080"
     - name: Run clang-tidy
       run: |
-        make bazel-clang-tidy BAZELOPT="--remote_cache=http://bazel-cache.sail:8080"
+        make clang-tidy BAZELOPT="--remote_cache=http://bazel-cache.sail:8080"

Makefile

@@ -81,8 +81,8 @@ buildifier: buildifier-install
 
 # bazel build/test
 
-bazel-clang-tidy: clang-tidy-install
-	bazel build $(BAZELOPT) //... --config=clang-tidy --config=release
+clang-tidy: clang-tidy-install
+	bazel build $(BAZELOPT) //... --config=clang-tidy --config=test
 
 bazel-debug: bazel-install
 	bazel build $(BAZELOPT) //... --config=debug
@@ -91,13 +91,19 @@ bazel-debug: bazel-install
 	cp bazel-bin/setup.runfiles/$(PROJECT_NAME)/dist/*.whl ./dist
 
 bazel-build: bazel-install
+	bazel build $(BAZELOPT) //... --config=test
+	bazel run $(BAZELOPT) //:setup --config=test -- bdist_wheel
+	mkdir -p dist
+	cp bazel-bin/setup.runfiles/$(PROJECT_NAME)/dist/*.whl ./dist
+
+bazel-release: bazel-install
 	bazel build $(BAZELOPT) //... --config=release
 	bazel run $(BAZELOPT) //:setup --config=release -- bdist_wheel
 	mkdir -p dist
 	cp bazel-bin/setup.runfiles/$(PROJECT_NAME)/dist/*.whl ./dist
 
 bazel-test: bazel-install
-	bazel test --test_output=all $(BAZELOPT) //... --config=release --config=test
+	bazel test --test_output=all $(BAZELOPT) //... --config=test
 
 bazel-clean: bazel-install
 	bazel clean --expunge
@@ -119,7 +125,7 @@ spelling: doc-install
 doc-clean:
 	cd docs && make clean
 
-lint: buildifier flake8 py-format clang-format cpplint bazel-clang-tidy mypy docstyle spelling
+lint: buildifier flake8 py-format clang-format cpplint clang-tidy mypy docstyle spelling
 
 format: py-format-install clang-format-install buildifier-install addlicense-install
 	isort $(PYTHON_FILES)
@@ -147,7 +153,7 @@ docker-release:
 	docker run --network=host -v `pwd`/wheelhouse:/whl -it $(PROJECT_NAME)-release:$(COMMIT_HASH) bash -c "cp wheelhouse/* /whl"
 	echo successfully build docker image with tag $(PROJECT_NAME)-release:$(COMMIT_HASH)
 
-pypi-wheel: auditwheel-install bazel-build
+pypi-wheel: auditwheel-install bazel-release
 	ls dist/*.whl -Art | tail -n 1 | xargs auditwheel repair --plat manylinux_2_17_x86_64
 
 release-test1:

docs/pages/build.rst

@@ -64,7 +64,7 @@ or `golang <https://golang.org/doc/install>`_ with version >= 1.16:
 Install Other Dependencies
 --------------------------
 
-EnvPool requires gcc/g++ version >= 9.0 to build the source code. To install:
+EnvPool requires **GCC/G++ version >= 9.0** to build the source code. To install:
 
 .. code-block:: bash
 
@@ -77,7 +77,7 @@ EnvPool requires gcc/g++ version >= 9.0 to build the source code. To install:
     # to change the default cc to gcc-9:
     sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-9 60 --slave /usr/bin/g++ g++ /usr/bin/g++-9
 
-It also requires python version >= 3.7:
+It also requires **Python version >= 3.7**:
 
 .. code-block:: bash
 

docs/pages/contributing.rst

@@ -65,7 +65,7 @@ integration; however, you don't want to build other stuff such as OpenCV:
 
 .. code-block:: bash
 
-    bazel test --test_output=all //envpool/mujoco:mujoco_test --config=release
+    bazel test --test_output=all //envpool/mujoco:mujoco_test --config=test
     # or alternatively
     cd bazel-bin/envpool/mujoco/mujoco_test.runfiles/envpool/
     ./envpool/mujoco/mujoco_test

envpool/__init__.py

@@ -23,7 +23,7 @@
   register,
 )
 
-__version__ = "0.5.1"
+__version__ = "0.5.2"
 __all__ = [
   "register",
   "make",

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = envpool
-version = 0.5.1
+version = 0.5.2
 author = "EnvPool Contributors"
 author_email = "[email protected]"
 description = "C++-based high-performance parallel environment execution engine (vectorized env) for general RL environments."