Skip to content
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.

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

build: moves editable installs to make dev #81

Merged
merged 1 commit into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/pull-request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
with:
python-version: ${{ matrix.python-version }}
- run: make deps
- run: make install
- run: make dev
- run: make test
# Run coverage on one of the builds, doesn't matter which
- if: ${{ matrix.python-version == '3.12' }}
Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Before contributing to the `posit-sdk`, ensure that the following prerequisites
1. Commit your changes and push them to your forked repository.
1. Submit a pull request to the main repository.

Please ensure that your code follows the project's coding conventions and style guidelines using `make lint`. Also, make sure to include tests for any new functionality or bug fixes.
Please ensure that your code follows the project's coding conventions and style guidelines using the configured pre-commit hooks. Run `pre-commit install` install to configure this functionality on your machine.

Also, make sure to include tests for any new functionality or bug fixes.

## Tooling

Expand Down
24 changes: 13 additions & 11 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.DEFAULT_GOAL := all

# Name of the project
NAME := posit-sdk

Expand All @@ -11,6 +13,7 @@ PYTHON := python3
cov
default
deps
dev
fmt
fix
install
Expand All @@ -20,12 +23,7 @@ PYTHON := python3
version

# Default target that runs the necessary steps to build the project
default:
make deps
make install
make test
make lint
make build
all: deps dev test lint build

# Target for building the project, which will generate the distribution files in the `dist` directory.
build:
Expand Down Expand Up @@ -54,17 +52,21 @@ cov-xml:
deps:
$(PIP) install -r requirements.txt -r requirements-dev.txt

# Target for formatting the code.
fmt:
$(PYTHON) -m ruff format .
# Target for installing the project in editable mode
dev:
$(PIP) install -e .

# Target for fixing linting issues.
fix:
$(PYTHON) -m ruff check --fix

# Target for installing the project in editable mode
# Target for formatting the code.
fmt:
$(PYTHON) -m ruff format .

# Target for installing the built distribution
install:
$(PIP) install -e .
$(PIP) install dist/*.whl

# Target for running static type checking and linting
lint:
Expand Down
Loading