-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
1,084 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"version": { | ||
"src/databricks/labs/pylint/__about__.py": "__version__ = \"$VERSION\"" | ||
}, | ||
"toolchain": { | ||
"required": ["python3", "hatch"], | ||
"pre_setup": ["hatch env create"], | ||
"prepend_path": ".venv/bin", | ||
"acceptance_path": "tests/integration", | ||
"test": [ | ||
"pytest -n 4 --cov src --cov-report=xml --timeout 30 tests/unit --durations 20" | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "pip" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: build | ||
|
||
on: | ||
pull_request: | ||
types: [opened, synchronize] | ||
merge_group: | ||
types: [checks_requested] | ||
push: | ||
# Always run on push to main. The build cache can only be reused | ||
# if it was saved by a run from the repository's default branch. | ||
# The run result will be identical to that from the merge queue | ||
# because the commit is identical, yet we need to perform it to | ||
# seed the build cache. | ||
branches: | ||
- main | ||
|
||
jobs: | ||
ci: | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
pyVersion: [ '3.10', '3.11', '3.12' ] | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- name: Install Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
cache: 'pip' | ||
cache-dependency-path: '**/pyproject.toml' | ||
python-version: ${{ matrix.pyVersion }} | ||
|
||
- name: Run unit tests | ||
run: | | ||
pip install hatch==1.9.4 | ||
make test | ||
- name: Publish test coverage | ||
uses: codecov/codecov-action@v1 | ||
|
||
fmt: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- name: Format all files | ||
run: make dev fmt | ||
|
||
- name: Fail on differences | ||
run: git diff --exit-code |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
name: Release | ||
|
||
on: | ||
push: | ||
tags: | ||
- 'v*' | ||
|
||
jobs: | ||
publish: | ||
runs-on: ubuntu-latest | ||
environment: release | ||
permissions: | ||
# Used to authenticate to PyPI via OIDC and sign the release's artifacts with sigstore-python. | ||
id-token: write | ||
# Used to attach signing artifacts to the published release. | ||
contents: write | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- uses: actions/setup-python@v4 | ||
with: | ||
cache: 'pip' | ||
cache-dependency-path: '**/pyproject.toml' | ||
python-version: '3.10' | ||
|
||
- name: Build wheels | ||
run: | | ||
pip install hatch==1.9.4 | ||
hatch build | ||
- name: Draft release | ||
uses: softprops/action-gh-release@v1 | ||
with: | ||
draft: true | ||
files: | | ||
dist/databricks_*.whl | ||
dist/databricks_*.tar.gz | ||
- uses: pypa/gh-action-pypi-publish@release/v1 | ||
name: Publish package distributions to PyPI | ||
|
||
- name: Sign artifacts with Sigstore | ||
uses: sigstore/gh-action-sigstore-python@v2.1.1 | ||
with: | ||
inputs: | | ||
dist/databricks_*.whl | ||
dist/databricks_*.tar.gz | ||
release-signing-artifacts: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Version changelog | ||
|
||
## 0.0.0 | ||
|
||
Initial pylint plugin commit |
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @nfx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
# Contributing | ||
|
||
## First Principles | ||
|
||
Favoring standard libraries over external dependencies, especially in specific contexts like Databricks, is a best practice in software | ||
development. | ||
|
||
There are several reasons why this approach is encouraged: | ||
- Standard libraries are typically well-vetted, thoroughly tested, and maintained by the official maintainers of the programming language or platform. This ensures a higher level of stability and reliability. | ||
- External dependencies, especially lesser-known or unmaintained ones, can introduce bugs, security vulnerabilities, or compatibility issues that can be challenging to resolve. Adding external dependencies increases the complexity of your codebase. | ||
- Each dependency may have its own set of dependencies, potentially leading to a complex web of dependencies that can be difficult to manage. This complexity can lead to maintenance challenges, increased risk, and longer build times. | ||
- External dependencies can pose security risks. If a library or package has known security vulnerabilities and is widely used, it becomes an attractive target for attackers. Minimizing external dependencies reduces the potential attack surface and makes it easier to keep your code secure. | ||
- Relying on standard libraries enhances code portability. It ensures your code can run on different platforms and environments without being tightly coupled to specific external dependencies. This is particularly important in settings like Databricks, where you may need to run your code on different clusters or setups. | ||
- External dependencies may have their versioning schemes and compatibility issues. When using standard libraries, you have more control over versioning and can avoid conflicts between different dependencies in your project. | ||
- Fewer external dependencies mean faster build and deployment times. Downloading, installing, and managing external packages can slow down these processes, especially in large-scale projects or distributed computing environments like Databricks. | ||
- External dependencies can be abandoned or go unmaintained over time. This can lead to situations where your project relies on outdated or unsupported code. When you depend on standard libraries, you have confidence that the core functionality you rely on will continue to be maintained and improved. | ||
|
||
While minimizing external dependencies is essential, exceptions can be made case-by-case. There are situations where external dependencies are | ||
justified, such as when a well-established and actively maintained library provides significant benefits, like time savings, performance improvements, | ||
or specialized functionality unavailable in standard libraries. | ||
|
||
## Common fixes for `mypy` errors | ||
|
||
See https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html for more details | ||
|
||
### ..., expression has type "None", variable has type "str" | ||
|
||
* Add `assert ... is not None` if it's a body of a method. Example: | ||
|
||
``` | ||
# error: Argument 1 to "delete" of "DashboardWidgetsAPI" has incompatible type "str | None"; expected "str" | ||
self._ws.dashboard_widgets.delete(widget.id) | ||
``` | ||
|
||
after | ||
|
||
``` | ||
assert widget.id is not None | ||
self._ws.dashboard_widgets.delete(widget.id) | ||
``` | ||
|
||
* Add `... | None` if it's in the dataclass. Example: `cloud: str = None` -> `cloud: str | None = None` | ||
|
||
### ..., has incompatible type "Path"; expected "str" | ||
|
||
Add `.as_posix()` to convert Path to str | ||
|
||
### Argument 2 to "get" of "dict" has incompatible type "None"; expected ... | ||
|
||
Add a valid default value for the dictionary return. | ||
|
||
Example: | ||
```python | ||
def viz_type(self) -> str: | ||
return self.viz.get("type", None) | ||
``` | ||
|
||
after: | ||
|
||
Example: | ||
```python | ||
def viz_type(self) -> str: | ||
return self.viz.get("type", "UNKNOWN") | ||
``` | ||
|
||
## Local Setup | ||
|
||
This section provides a step-by-step guide to set up and start working on the project. These steps will help you set up your project environment and dependencies for efficient development. | ||
|
||
To begin, run `make dev` create the default environment and install development dependencies, assuming you've already cloned the github repo. | ||
|
||
```shell | ||
make dev | ||
``` | ||
|
||
Verify installation with | ||
```shell | ||
make test | ||
``` | ||
|
||
Before every commit, apply the consistent formatting of the code, as we want our codebase look consistent: | ||
```shell | ||
make fmt | ||
``` | ||
|
||
Before every commit, run automated bug detector (`make lint`) and unit tests (`make test`) to ensure that automated | ||
pull request checks do pass, before your code is reviewed by others: | ||
```shell | ||
make test | ||
``` | ||
|
||
## First contribution | ||
|
||
Here are the example steps to submit your first contribution: | ||
|
||
1. Make a Fork from ucx repo (if you really want to contribute) | ||
2. `git clone` | ||
3. `git checkout main` (or `gcm` if you're using [ohmyzsh](https://ohmyz.sh/)). | ||
4. `git pull` (or `gl` if you're using [ohmyzsh](https://ohmyz.sh/)). | ||
5. `git checkout -b FEATURENAME` (or `gcb FEATURENAME` if you're using [ohmyzsh](https://ohmyz.sh/)). | ||
6. .. do the work | ||
7. `make fmt` | ||
8. `make lint` | ||
9. .. fix if any | ||
10. `make test` | ||
11. .. fix if any | ||
12. `git commit -a`. Make sure to enter meaningful commit message title. | ||
13. `git push origin FEATURENAME` | ||
14. Go to GitHub UI and create PR. Alternatively, `gh pr create` (if you have [GitHub CLI](https://cli.github.com/) installed). | ||
Use a meaningful pull request title because it'll appear in the release notes. Use `Resolves #NUMBER` in pull | ||
request description to [automatically link it](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue) | ||
to an existing issue. | ||
15. announce PR for the review | ||
|
||
## Troubleshooting | ||
|
||
If you encounter any package dependency errors after `git pull`, run `make clean` |
Oops, something went wrong.