Commit fbfa21b
authored
Merge pull request juju#1030 from cderici/build-test-and-issue-template
juju#1030
#### Description
This does two things:
1. Adds a Makefile target called `build-test` that runs the `setup.py sdist` and installs the artifact in a virtual environment and runs a very simple command on it. The purpose of this is to catch the build and runtime dependency problems early on whenever a change is made that'll effect the release down the road (i.e. before it blows up when a new version is released). We add it into a GH action job as well to automatically catch these issues.
For example, having something like this would've saved us from hitting juju#1025 on the `3.3.1.0` release, which is the sole reason we had to make a new release https://github.com/juju/python-libjuju/releases/tag/3.3.1.1 afterwards.
2. Updates the bug report template and adds `Please provide a simplified reproducer, and if it's possible please refrain from providing a "clone this repository and run the integration tests to see the problem" type of a reproducer. Thanks!`, which is pretty self-explanatory.
#### QA Steps
Just running the make target to see if it succeeds locally should be sufficient to QA this:
```
make build-test
```
And maybe some manual checking for typos in the template message (b/c user-facing) could help.3 files changed
Lines changed: 32 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -48,7 +48,9 @@ body: | |||
| 48 | 48 | id: info | |
| 49 | 49 | attributes: | |
| 50 | 50 | label: "Reproduce / Test" | |
| 51 | - description: "Please add valid Python code to reproduce the bug. This will be used as a test for QAing later on." | ||
| 51 | + description: "Please add valid Python code to reproduce the bug. This will be used as a test for QAing later on. | ||
| 52 | + | ||
| 53 | + Please provide a simplified reproducer, and if it's possible please refrain from providing a "clone this repository and run the integration tests to see the problem" type of a reproducer. Thanks!" | ||
| 52 | 54 | render: python | |
| 53 | 55 | validations: | |
| 54 | 56 | required: true | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -25,6 +25,24 @@ jobs: | |||
| 25 | 25 | tox -e lint | |
| 26 | 26 | ./scripts/copyright.sh | |
| 27 | 27 | ||
| 28 | + build-test: | ||
| 29 | + name: Build test | ||
| 30 | + runs-on: ubuntu-latest | ||
| 31 | + strategy: | ||
| 32 | + matrix: | ||
| 33 | + python: | ||
| 34 | + - "3.10" | ||
| 35 | + steps: | ||
| 36 | + - name: Check out code | ||
| 37 | + uses: actions/checkout@v3 | ||
| 38 | + - name: Setup Python | ||
| 39 | + uses: actions/setup-python@v4 | ||
| 40 | + with: | ||
| 41 | + python-version: ${{ matrix.python }} | ||
| 42 | + - name: Run build test target | ||
| 43 | + run: | | ||
| 44 | + make build-test | ||
| 45 | + | ||
| 28 | 46 | unit-tests: | |
| 29 | 47 | needs: lint | |
| 30 | 48 | name: Unit tests | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,7 +1,7 @@ | |||
| 1 | 1 | BIN := .tox/py3/bin | |
| 2 | 2 | PY := $(BIN)/python3 | |
| 3 | 3 | PIP := $(BIN)/pip3 | |
| 4 | - VERSION := $(shell $(PY) -c "from juju.version import CLIENT_VERSION; print(CLIENT_VERSION)") | ||
| 4 | + VERSION := $(shell python3 -c "from juju.version import CLIENT_VERSION; print(CLIENT_VERSION)") | ||
| 5 | 5 | ||
| 6 | 6 | .PHONY: clean | |
| 7 | 7 | clean: | |
@@ -40,6 +40,16 @@ lint: | |||
| 40 | 40 | docs: | |
| 41 | 41 | tox -e docs | |
| 42 | 42 | ||
| 43 | + .PHONY: build-test | ||
| 44 | + build-test: | ||
| 45 | + rm -rf venv | ||
| 46 | + python3 -m venv venv | ||
| 47 | + . venv/bin/activate | ||
| 48 | + python3 setup.py sdist | ||
| 49 | + pip install ./dist/juju-${VERSION}.tar.gz | ||
| 50 | + python3 -c "from juju.controller import Controller" | ||
| 51 | + rm ./dist/juju-${VERSION}.tar.gz | ||
| 52 | + | ||
| 43 | 53 | .PHONY: release | |
| 44 | 54 | release: | |
| 45 | 55 | git fetch --tags | |
0 commit comments