mirror of
https://github.com/frappe/frappe_docker.git
synced 2024-09-19 18:49:01 +00:00
e6088af885
* ci: skip frappe builds * refactor: build only one frappe/erpnext image * fix: lint nginx entrypoint script * docs: update and organize docs * docs: fix lint errors * fix(custom): pass base64 encoded apps json * ci: update dependabot * docs: update contributing * docs: remove info about multi image setup * fix: initiate empty common_site_config.json default config has host keys set to localhost causes connection errors * docs: add details for pwd volumes * fix: symlink assets instead of copy * fix: nginx private files * ci: skip docker compose v2 install for ubuntu-latest * fix: organize layers * feat: allow remove git remote for custom image * docs: allow remove git remote for custom image * fix: remove duplicate --apps_path
71 lines
1.5 KiB
Markdown
71 lines
1.5 KiB
Markdown
# Contribution Guidelines
|
|
|
|
Before publishing a PR, please test builds locally.
|
|
|
|
On each PR that contains changes relevant to Docker builds, images are being built and tested in our CI (GitHub Actions).
|
|
|
|
> :evergreen_tree: Please be considerate when pushing commits and opening PR for multiple branches, as the process of building images uses energy and contributes to global warming.
|
|
|
|
## Lint
|
|
|
|
We use `pre-commit` framework to lint the codebase before committing.
|
|
First, you need to install pre-commit with pip:
|
|
|
|
```shell
|
|
pip install pre-commit
|
|
```
|
|
|
|
Also you can use brew if you're on Mac:
|
|
|
|
```shell
|
|
brew install pre-commit
|
|
```
|
|
|
|
To setup _pre-commit_ hook, run:
|
|
|
|
```shell
|
|
pre-commit install
|
|
```
|
|
|
|
To run all the files in repository, run:
|
|
|
|
```shell
|
|
pre-commit run --all-files
|
|
```
|
|
|
|
## Build
|
|
|
|
We use [Docker Buildx Bake](https://docs.docker.com/engine/reference/commandline/buildx_bake/). To build the images, run command below:
|
|
|
|
```shell
|
|
FRAPPE_VERSION=... ERPNEXT_VERSION=... docker buildx bake <targets>
|
|
```
|
|
|
|
Available targets can be found in `docker-bake.hcl`.
|
|
|
|
## Test
|
|
|
|
We use [pytest](https://pytest.org) for our integration tests.
|
|
|
|
Install Python test requirements:
|
|
|
|
```shell
|
|
python3 -m venv venv
|
|
source venv/bin/activate
|
|
pip install -r requirements-test.txt
|
|
```
|
|
|
|
Run pytest:
|
|
|
|
```shell
|
|
pytest
|
|
```
|
|
|
|
# Documentation
|
|
|
|
Place relevant markdown files in the `docs` directory and index them in README.md located at the root of repo.
|
|
|
|
# Frappe and ERPNext updates
|
|
|
|
Each Frappe/ERPNext release triggers new stable images builds as well as bump to helm chart.
|