-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #33 from rok4/develop
Release 5.5.0
- Loading branch information
Showing
26 changed files
with
262 additions
and
145 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 |
---|---|---|
|
@@ -46,7 +46,9 @@ jobs: | |
|
||
steps: | ||
- name: Checkout project | ||
uses: actions/checkout@v3 | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Install system dependencies | ||
run: | | ||
|
@@ -85,69 +87,40 @@ jobs: | |
cd build | ||
make doc | ||
cd .. | ||
cp -r README.md CHANGELOG.md docs/openapi.yaml docs/images config/*.schema.json dist/ | ||
- name: Upload documentation | ||
if: "matrix.os == 'ubuntu-20.04'" | ||
uses: actions/upload-artifact@v3 | ||
cp docs/mkdocs.yml target/mkdocs.yml | ||
cp -r docs/overrides target/ | ||
cp -r docs/images target/docs/ | ||
cp -r config/ target/docs/ | ||
cp docs/documentation.md target/docs/documentation.md | ||
cp docs/openapi.md target/docs/openapi.md | ||
cp docs/README.hdr.md target/docs/README.md | ||
cp docs/CHANGELOG.hdr.md target/docs/CHANGELOG.md | ||
cp docs/CONTRIBUTING.hdr.md target/docs/CONTRIBUTING.md | ||
sed "s#__version__#${{ github.ref_name }}#g" docs/openapi.yaml >>target/docs/openapi.yaml | ||
sed "s#x.y.z#${{ github.ref_name }}#g" README.md >>target/docs/README.md | ||
sed -i "s#](./docs/images/#](./images/#g" target/docs/README.md | ||
cat CHANGELOG.md >>target/docs/CHANGELOG.md | ||
cat CONTRIBUTING.md >>target/docs/CONTRIBUTING.md | ||
- name: Setup python | ||
uses: actions/setup-python@v4 | ||
with: | ||
name: dist-py3 | ||
path: dist/ | ||
if-no-files-found: error | ||
retention-days: 1 | ||
|
||
commit_documentation: | ||
name: Add documentation into gh-pages branch | ||
needs: build_and_test | ||
if: "always()&&(needs.create_release.outputs.job_status=='success')&&(needs.build_and_test.outputs.job_status=='success')" | ||
runs-on: ubuntu-latest | ||
python-version: "3.10" | ||
cache: 'pip' | ||
|
||
steps: | ||
|
||
- name: Checkout project on gh-pages | ||
uses: actions/checkout@v3 | ||
with: | ||
ref: 'gh-pages' | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
- name: Install Mkdocs | ||
run: pip install -r docs/requirements.txt | ||
|
||
- uses: actions/download-artifact@v3 | ||
with: | ||
name: dist-py3 | ||
path: artifact/ | ||
|
||
- name: Copy version elements to final location | ||
run: | | ||
mkdir -p docs/versions/${{ github.ref_name }}/docs docs/versions/${{ github.ref_name }}/config | ||
cp -r artifact/html docs/versions/${{ github.ref_name }}/ | ||
cp -r artifact/images docs/versions/${{ github.ref_name }}/docs/ | ||
cp -r artifact/*.schema.json docs/versions/${{ github.ref_name }}/config/ | ||
- name: Add pages from templates | ||
run: | | ||
sed "s#__version__#${{ github.ref_name }}#" templates/mkdocs.template.yml >mkdocs.yml | ||
sed "s#__version__#${{ github.ref_name }}#" templates/documentation.template.md >docs/versions/${{ github.ref_name }}/documentation.md | ||
sed "s#__version__#${{ github.ref_name }}#" templates/index-version.template.md >docs/versions/${{ github.ref_name }}/index.md | ||
cat artifact/README.md >>docs/versions/${{ github.ref_name }}/index.md | ||
sed -i "s#x.y.z#${{ github.ref_name }}#g" docs/versions/${{ github.ref_name }}/index.md | ||
sed "s#__version__#${{ github.ref_name }}#" templates/openapi.template.md >docs/versions/${{ github.ref_name }}/openapi.md | ||
sed "s#__version__#${{ github.ref_name }}#" artifact/openapi.yaml >docs/versions/${{ github.ref_name }}/openapi.yaml | ||
cp templates/index-versions.template.md docs/versions/index.md | ||
sed "s/^## \(.*\)$/## \1 \n\n[➔ Lien vers la documentation](\1\/index.md) /" artifact/CHANGELOG.md >>docs/versions/index.md | ||
sed "s#__version__#${{ github.ref_name }}#" templates/latest.template.html >docs/versions/latest/index.html | ||
rm -r artifact | ||
- name: Publish on gh-pages branch | ||
- name: Publish documentation | ||
if: "matrix.os == 'ubuntu-20.04'" | ||
run: | | ||
git config user.name github-actions | ||
git config user.email [email protected] | ||
git add -v docs/versions/${{ github.ref_name }}/ docs/versions/latest/ docs/index.md docs/versions/index.md mkdocs.yml | ||
git commit -m "Add documentation for version ${{ github.ref_name }}" | ||
git push | ||
cd target/ | ||
mike deploy --push --update-aliases --branch gh-pages -t "Version ${{ github.ref_name }}" ${{ github.ref_name }} latest | ||
mike set-default --push --branch gh-pages ${{ github.ref_name }} | ||
delete_version: | ||
name: Remove release and tag if error occured | ||
|
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,3 +1,4 @@ | ||
build | ||
.vscode | ||
dist | ||
dist | ||
target |
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,4 @@ | ||
--- | ||
hide: | ||
- navigation | ||
--- |
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,4 @@ | ||
--- | ||
hide: | ||
- navigation | ||
--- |
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,4 @@ | ||
--- | ||
hide: | ||
- navigation | ||
--- |
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,9 @@ | ||
--- | ||
hide: | ||
- navigation | ||
- toc | ||
--- | ||
|
||
# Documentation technique | ||
|
||
<iframe src="../html/index.html"></iframe> |
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,30 @@ | ||
site_name: "Projet ROK4 - Serveur de diffusion WMS, WMTS et TMS" | ||
site_url: https://rok4.github.io/server | ||
nav: | ||
- Accueil: README.md | ||
- Spécification de l'API: openapi.md | ||
- Documentation technique: documentation.md | ||
- Historique des versions: CHANGELOG.md | ||
- Contribuer: CONTRIBUTING.md | ||
|
||
theme: | ||
logo: https://rok4.github.io/assets/images/rok4-carre.png | ||
favicon: https://rok4.github.io/assets/images/rok4-carre.png | ||
name: material | ||
features: | ||
- navigation.tabs | ||
- navigation.tabs.sticky | ||
language: fr | ||
custom_dir: overrides | ||
|
||
extra_css: | ||
- https://rok4.github.io/assets/css/commun.css | ||
|
||
extra: | ||
homepage: https://rok4.github.io | ||
version: | ||
provider: mike | ||
default: latest | ||
|
||
plugins: | ||
- render_swagger |
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,9 @@ | ||
--- | ||
hide: | ||
- navigation | ||
- toc | ||
--- | ||
|
||
# Spécifications de l'API | ||
|
||
!!swagger openapi.yaml!! |
Oops, something went wrong.