Skip to content
Snippets Groups Projects
Commit 9e55eb2f authored by geant-release-service's avatar geant-release-service
Browse files

Finished release 1.1.

parents b80f5a35 2dc0cb2c
No related branches found
No related tags found
No related merge requests found
Pipeline #85683 passed
name: "Sphinx: render docs"
on:
push:
branches:
- develop
jobs:
docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Set up Python environment
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install requirements
run: |
python3 -m pip install -r requirements.txt
python3 -m pip install -e .
- name: Build documentation
run: TZ=UTC sphinx-build -b html docs/source docs/build
- uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/
enable_jekyll: false
......@@ -9,7 +9,7 @@ coverage.xml
docs/build
docs/source/_static/openapi.json
docs/vale/styles/*
!docs/vale/styles/Vocab/
!docs/vale/styles/config/
venv/
.venv/
......
......@@ -2,6 +2,7 @@
stages:
- tox
- documentation
- sonarqube
- trigger_jenkins_build
include:
......@@ -42,6 +43,14 @@ run-tox-pipeline:
- htmlcov
- docs/source/_static/openapi.json
sonarqube:
stage: sonarqube
image: sonarsource/sonar-scanner-cli
script:
- sonar-scanner -Dsonar.login=$SONAR_TOKEN -Dproject.settings=./sonar.properties
tags:
- docker-executor
trigger_jenkins_build:
stage: trigger_jenkins_build
image: alpine:latest
......
# Changelog
All notable changes to this project will be documented in this file.
## [1.1] - 2024-02-09
GEANT GAP Ansible collection is with version in galaxy requirements.
## [1.0] - 2024-01-03
The very first major release of LSO is here! :tada: A transparent API for running Ansible playbooks on a remote machine.
......
MIT License
Copyright (c) 2023 GÉANT Vereniging
Copyright (c) 2023-2024 GÉANT Vereniging
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
......
......@@ -2,12 +2,12 @@
LSO: an API that allows for remotely executing Ansible playbooks
## Running locally
### Standalone deployment
## General documentation
Build documentation using `build-docs.sh`, and check out the quickstart page.
General documentation is available at <https://docs.gap.geant.org/>
### Docker deployment
Run the following from the root, then refer to the above documentation for usage.
## Code documentation
Code documentation can be found at <https://workfloworchestrator.org/lso>
\ No newline at end of file
collections:
- community.general
- juniper.device
- junipernetworks.junos
- geant.gap_ansible
- community.general
- juniper.device
- junipernetworks.junos
- name: geant.gap_ansible
version: 1.0.46
roles:
- Juniper.junos
- Juniper.junos
......@@ -5,12 +5,8 @@ set -o nounset
pip install -r requirements.txt
pip install -e .
export SETTINGS_FILENAME=./config.json.example
python docs/dump-openapi-spec.py
rm -r ./docs/build/*
vale --config=docs/vale/.vale.ini sync
vale --config=docs/vale/.vale.ini docs/source/*.rst lso/*.py
sphinx-build -b html docs/source docs/build
unset SETTINGS_FILENAME
sphinx-build -b html docs/source docs/build
......@@ -12,7 +12,8 @@ lint-documentation:
- job: run-tox-pipeline # Only run when tox has finished
before_script:
- vale --config=docs/vale/.vale.ini sync
- cd $CI_PROJECT_DIR/docs/vale
- vale sync
script:
- vale --config=docs/vale/.vale.ini docs/source/*.rst lso/*.py
- vale $CI_PROJECT_DIR/docs/source/*.rst $CI_PROJECT_DIR/lso/*.py
import json
import os
from fastapi.testclient import TestClient
import lso
config_filename = os.path.join(os.path.dirname(__file__), "..", "config.json.example")
output_filename = os.path.join(os.path.dirname(__file__), "source", "_static", "openapi.json")
os.environ["SETTINGS_FILENAME"] = config_filename
app = lso.create_app()
client = TestClient(app)
rsp = client.get("/openapi.json")
openapi_doc = json.dumps(rsp.json(), indent=2)
with open(output_filename, "w") as f:
f.write(openapi_doc)
print(f"wrote {output_filename}")
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta
name="description"
content="SwaggerUI"
/>
<title>SwaggerUI</title>
<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui.css" />
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui-bundle.js" crossorigin></script>
<script>
window.onload = () => {
window.ui = SwaggerUIBundle({
url: 'openapi.json',
dom_id: '#swagger-ui',
});
};
</script>
</body>
</html>
......@@ -9,6 +9,3 @@ Documentation for LSO (Lightweight Service Orchestrator).
quickstart
modules
`Swagger API Docs <_static/openapi.html>`_
......@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
setup(
name="goat-lso",
version="1.0",
version="1.1",
author="GÉANT Orchestration & Automation Team",
author_email="goat@geant.org",
description="Lightweight Service Orchestrator",
......
sonar.projectKey=lso
sonar.projectName='Lightweight Service Orchestrator'
sonar.projectVersion=1.0
sonar.sources=lso
sonar.python.coverage.reportPaths=coverage.xml
sonar.host.url=https://sonarqube.software.geant.org/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment