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

update CI to checkout v4, fix docs build warnings #753

Merged
merged 8 commits into from
Aug 30, 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/containers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:

steps:
- name: Checkout branch
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Set up QEMU
uses: docker/setup-qemu-action@v1
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
name: setup Python
with:
python-version: 3.8
python-version: "3.10"
- name: build docs ⚙️
uses: ammaraskar/sphinx-action@master
with:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/tests-docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
name: setup Python
with:
python-version: 3.8
python-version: "3.10"
- name: install testing requirements 📦
working-directory: tests
run: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/zaproxy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: build and start containers using tests/test.env ⚙️
run: |
cp tests/test.env wis2box.env
Expand Down Expand Up @@ -47,4 +47,4 @@ jobs:
target: 'http://localhost/wis2box-webapp'
rules_file_name: '.zap/rules.tsv'
allow_issue_writing: 'false'
fail_action: 'true'
fail_action: 'true'
2 changes: 1 addition & 1 deletion docker-compose.monitoring.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ services:
restart: unless-stopped
env_file:
- wis2box.env
#image: ghcr.io/wmo-im/wis2box-mqtt-metrics-collector:1.0.beta1
#image: ghcr.io/wmo-im/wis2box-mqtt-metrics-collector:latest
build:
context: ./wis2box-mqtt-metrics-collector
depends_on:
Expand Down
16 changes: 3 additions & 13 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,6 @@ services:
depends_on:
- wis2box-api

# wis2box-ui-admin:
# container_name: wis2box-ui-admin
# image: ghcr.io/wmo-im/wis2box-ui-admin:latest
# restart: always
# env_file:
# - wis2box.env
# depends_on:
# - wis2box-api

wis2box-webapp:
container_name: wis2box-webapp
image: ghcr.io/wmo-im/wis2box-webapp:latest
Expand Down Expand Up @@ -103,7 +94,7 @@ services:

mosquitto:
container_name: mosquitto
#image: ghcr.io/wmo-im/wis2box-broker:1.0.beta1
#image: ghcr.io/wmo-im/wis2box-broker:latest
restart: always
build:
context: ./wis2box-broker
Expand All @@ -115,7 +106,7 @@ services:
mem_limit: 1g
memswap_limit: 1g
restart: always
#image: ghcr.io/wmo-im/wis2box-management:1.0.beta1
#image: ghcr.io/wmo-im/wis2box-management:latest
build:
context: ./wis2box-management
#user: wis2box:wis2box
Expand Down Expand Up @@ -154,9 +145,8 @@ services:
volumes:
- ${WIS2BOX_HOST_DATADIR}/downloads:/home/wis2downloader/app/data/downloads


volumes:
es-data:
minio-data:
auth-data:
htpasswd:
htpasswd:
3 changes: 2 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXOPTS = -W
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
Expand All @@ -17,4 +17,5 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
echo @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ ipython_genutils
jinja2
jupyter
nbsphinx
pygments-csv-lexer
pyzmq==23.2.1
pypandoc
sphinx
Expand Down
20 changes: 12 additions & 8 deletions docs/source/user/gts-headers-in-wis2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ To enable the WIS2 to GTS Gateway to correctly identify the data to be republish

.. code-block:: json

"properties": {
"gts": {
"ttaaii": "FTAE31",
"cccc": "VTBB"
{
"properties": {
"gts": {
"ttaaii": "FTAE31",
"cccc": "VTBB"
}
}
}

Expand Down Expand Up @@ -47,10 +49,12 @@ the corresponding GTS headers will be added to the WIS2 Notification Message as

.. code-block:: json

"properties": {
"gts": {
"ttaaii": "ISMD01",
"cccc": "LIBB"
{
"properties": {
"gts": {
"ttaaii": "ISMD01",
"cccc": "LIBB"
}
}
}

Expand Down