Skip to content

Add st2client README checks to CI #5306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amanda11 merged 7 commits into from
Jul 17, 2021
Merged

Add st2client README checks to CI #5306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a9fd37f
Initial changes, with dummy break of st2client README to check failiu…
amanda11 Jul 16, 2021
9c1f951
Error in Makefile
amanda11 Jul 16, 2021
1629ab6
Make sure last command is the checker not cd
amanda11 Jul 16, 2021
ca6313a
Fix whitespace
amanda11 Jul 16, 2021
164b637
Put readme back to valid now got correct error
amanda11 Jul 16, 2021
2d5c66a
Update comments in Makefile
amanda11 Jul 16, 2021
0fa477e
Update Makefile
amanda11 Jul 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ OS := $(shell uname)
ifeq ($(OS),Darwin)
VIRTUALENV_DIR ?= virtualenv-osx
VIRTUALENV_ST2CLIENT_DIR ?= virtualenv-st2client-osx
VIRTUALENV_ST2CLIENT_PYPI_DIR ?= virtualenv-st2client-pypi-osx
VIRTUALENV_COMPONENTS_DIR ?= virtualenv-components-osx
else
VIRTUALENV_DIR ?= virtualenv
VIRTUALENV_ST2CLIENT_DIR ?= virtualenv-st2client
VIRTUALENV_ST2CLIENT_PYPI_DIR ?= virtualenv-st2client-pypi
VIRTUALENV_COMPONENTS_DIR ?= virtualenv-components
endif

Expand Down Expand Up @@ -478,6 +480,34 @@ flake8: requirements .flake8
. $(VIRTUALENV_DIR)/bin/activate; flake8 --config ./lint-configs/python/.flake8 tools/
. $(VIRTUALENV_DIR)/bin/activate; flake8 --config ./lint-configs/python/.flake8 pylint_plugins/

# Make task which verifies st2client README will parse pypi checks
. PHONY: .st2client-pypi-check
.st2client-pypi-check:
@echo
@echo "==================== st2client pypi check ===================="
@echo
test -f $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate || virtualenv --python=python3 $(VIRTUALENV_ST2CLIENT_PYPI_DIR) --no-download

# Setup PYTHONPATH in bash activate script...
# Delete existing entries (if any)
sed -i '/_OLD_PYTHONPATHp/d' $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate
sed -i '/PYTHONPATH=/d' $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate
sed -i '/export PYTHONPATH/d' $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate
echo '_OLD_PYTHONPATH=$$PYTHONPATH' >> $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate
echo 'PYTHONPATH=${ROOT_DIR}:$(COMPONENT_PYTHONPATH)' >> $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate
echo 'export PYTHONPATH' >> $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate
touch $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate
chmod +x $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate

$(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/pip install --upgrade "pip==$(PIP_VERSION)"
$(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/pip install --upgrade "readme_renderer"
$(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/pip install --upgrade "restructuredtext-lint"

# Check with readme-renderer
. $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate; cd st2client ; ../$(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/python -m readme_renderer README.rst
# Check with rst-lint - encounters errors that readme_renderer doesn't, but pypi complains about
. $(VIRTUALENV_ST2CLIENT_PYPI_DIR)/bin/activate; cd st2client ; rst-lint README.rst

# Make task which verifies st2client installs and works fine
.PHONY: .st2client-install-check
.st2client-install-check:
Expand Down Expand Up @@ -1105,7 +1135,7 @@ ci: ci-checks ci-unit ci-integration ci-packs-tests
# NOTE: pylint is moved to ci-compile so we more evenly spread the load across
# various different jobs to make the whole workflow complete faster
.PHONY: ci-checks
ci-checks: .generated-files-check .shellcheck .black-check .pre-commit-checks .flake8 check-requirements check-sdist-requirements .st2client-dependencies-check .st2common-circular-dependencies-check circle-lint-api-spec .rst-check .st2client-install-check check-python-packages
ci-checks: .generated-files-check .shellcheck .black-check .pre-commit-checks .flake8 check-requirements check-sdist-requirements .st2client-dependencies-check .st2common-circular-dependencies-check circle-lint-api-spec .rst-check .st2client-install-check check-python-packages .st2client-pypi-check

.PHONY: .rst-check
.rst-check:
Expand Down
1 change: 1 addition & 0 deletions st2client/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"automation platform."
),
long_description=readme,
long_description_content_type="text/x-rst",
author="StackStorm",
author_email="info@stackstorm.com",
url="https://stackstorm.com/",
Expand Down