-
-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: merge doc and workflow changes from dev
- Loading branch information
1 parent
ccc7820
commit 92f07fd
Showing
9 changed files
with
183 additions
and
39 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,57 @@ | ||
| name: Build CI Img | ||
|
|
||
| on: | ||
| # Push includes PR merge | ||
| push: | ||
| branches: | ||
| - main | ||
| - staging | ||
| - development | ||
| paths: | ||
| # Workflow is triggered only if deps change | ||
| - "src/backend/pyproject.toml" | ||
| - "src/backend/Dockerfile" | ||
| # Allow manual trigger | ||
| workflow_dispatch: | ||
|
|
||
| env: | ||
| REGISTRY: ghcr.io | ||
| GIT_BRANCH: ${{ github.ref_name }} | ||
|
|
||
| jobs: | ||
| build-and-push-images: | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: ${{ github.ref_name }} | ||
| permissions: | ||
| contents: read | ||
| packages: write | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Log in to the Container registry | ||
| uses: docker/login-action@v2 | ||
| with: | ||
| registry: ${{ env.REGISTRY }} | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Extract api version | ||
| id: extract_api_version | ||
| run: | | ||
| cd src/backend | ||
| echo "API_VERSION=$(python -c 'from app.__version__ import __version__; print(__version__)')" >> $GITHUB_ENV | ||
| - name: Build image | ||
| uses: docker/build-push-action@v4 | ||
| with: | ||
| context: src/backend | ||
| target: ci | ||
| push: true | ||
| tags: | | ||
| "ghcr.io/hotosm/fmtm/backend:${{ env.API_VERSION }}-ci-${{ github.ref_name }}" | ||
| "ghcr.io/hotosm/fmtm/backend:ci-${{ github.ref_name }}" | ||
| build-args: | | ||
| API_VERSION=${{ env.API_VERSION }} |
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
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
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 @@ | ||
| :root { | ||
| --md-primary-fg-color: #d73f3f; | ||
| --md-primary-fg-color--light: #e27575; | ||
| --md-primary-fg-color--dark: #c22929; | ||
| } |
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,48 @@ | ||
| # Troubleshooting 🆘 | ||
|
|
||
| ## Running FMTM standalone | ||
|
|
||
| - Although it's easiest to use Docker, sometimes it may no be feasible, or not preferred. | ||
| - We use a tool called PDM to manage dependencies. | ||
| - PDM can run in two modes: venv and PEP582 (`__pypackages__`). | ||
| - Be careful when running FMTM you are not accidentally pulling in your system packages. | ||
|
|
||
| ### Tips | ||
|
|
||
| - If a directory `__pypackages__` exists, delete it and attempt to | ||
| `pdm install` | ||
| again. | ||
| - If the `__pypackages__` directory returns, then force using venv instead | ||
| `pdm config python.use_venv true` | ||
| and remove the directory again. | ||
| - Troubleshoot the packages PDM sees with: | ||
| `pdm run pip list` | ||
| - Check a package can be imported in the PDM-based Python environment: | ||
|
|
||
| ```bash | ||
| pdm run python | ||
| import fastapi | ||
| ``` | ||
|
|
||
| If you receive errors such as: | ||
|
|
||
| ```bash | ||
| pydantic.error_wrappers.ValidationError: 3 validation errors for Settings | ||
| OSM_URL | ||
| field required (type=value_error.missing) | ||
| OSM_SCOPE | ||
| field required (type=value_error.missing) | ||
| OSM_LOGIN_REDIRECT_URI | ||
| field required (type=value_error.missing) | ||
| ``` | ||
|
|
||
| Then you need to set the env variables on your system. | ||
|
|
||
| If you would rather not do this, | ||
| an alternative can be to feed them into the pdm command: | ||
|
|
||
| ```bash | ||
| FRONTEND_MAIN_URL="" FRONTEND_MAP_URL="" \ | ||
| OSM_CLIENT_ID="" OSM_CLIENT_SECRET="" OSM_SECRET_KEY="" \ | ||
| pdm run uvicorn app.main:api --host 0.0.0.0 --port 8000 | ||
| ``` |
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