Skip to content

Commit 5c41508

Browse files
DoliteDolite
authored
Merge pull request #38 from rok4/develop
Release 1.3.1
2 parents 8d17433 + b9c4738 commit 5c41508

16 files changed

Lines changed: 196 additions & 248 deletions

‎.github/workflows/build-and-release.yaml‎

Lines changed: 25 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ jobs:
4646

4747
steps:
4848
- name: Checkout project
49-
uses: actions/checkout@v3
49+
uses: actions/checkout@v4
50+
with:
51+
fetch-depth: 0
5052

5153
- name: Install system dependencies
5254
run: |
@@ -85,65 +87,35 @@ jobs:
8587
cd build
8688
make doc
8789
cd ..
88-
cp README.md CHANGELOG.md dist/
89-
90-
- name: Upload documentation
91-
if: "matrix.os == 'ubuntu-20.04'"
92-
uses: actions/upload-artifact@v3
93-
with:
94-
name: dist-cpp
95-
path: dist/
96-
if-no-files-found: error
97-
retention-days: 1
98-
99-
commit_documentation:
100-
name: Add documentation into gh-pages branch
101-
needs: build_and_test
102-
if: "always()&&(needs.create_release.outputs.job_status=='success')&&(needs.build_and_test.outputs.job_status=='success')"
103-
runs-on: ubuntu-latest
104-
105-
steps:
106-
107-
- name: Checkout project on gh-pages
108-
uses: actions/checkout@v3
109-
with:
110-
ref: 'gh-pages'
111-
token: ${{ secrets.GITHUB_TOKEN }}
11290
113-
- uses: actions/download-artifact@v3
91+
cp docs/mkdocs.yml target/mkdocs.yml
92+
cp -r docs/overrides target/
93+
cp docs/documentation.md target/docs/documentation.md
94+
cp docs/README.hdr.md target/docs/README.md
95+
cp docs/CHANGELOG.hdr.md target/docs/CHANGELOG.md
96+
cp docs/CONTRIBUTING.hdr.md target/docs/CONTRIBUTING.md
97+
sed "s#x.y.z#${{ github.ref_name }}#g" README.md >>target/docs/README.md
98+
cat CHANGELOG.md >>target/docs/CHANGELOG.md
99+
cat CONTRIBUTING.md >>target/docs/CONTRIBUTING.md
100+
101+
- name: Setup python
102+
uses: actions/setup-python@v4
114103
with:
115-
name: dist-cpp
116-
path: artifact/
117-
118-
- name: Copy version elements to final location
119-
run: |
120-
mkdir -p docs/versions/${{ github.ref_name }}
121-
cp -r artifact/html docs/versions/${{ github.ref_name }}/
122-
123-
- name: Add pages from templates
124-
run: |
125-
sed "s#__version__#${{ github.ref_name }}#" templates/mkdocs.template.yml >mkdocs.yml
104+
python-version: "3.10"
105+
cache: 'pip'
126106

127-
sed "s#__version__#${{ github.ref_name }}#" templates/documentation.template.md >docs/versions/${{ github.ref_name }}/documentation.md
107+
- name: Install Mkdocs
108+
run: pip install -r docs/requirements.txt
128109

129-
sed "s#__version__#${{ github.ref_name }}#" templates/index-version.template.md >docs/versions/${{ github.ref_name }}/index.md
130-
cat artifact/README.md >>docs/versions/${{ github.ref_name }}/index.md
131-
sed -i "s#x.y.z#${{ github.ref_name }}#g" docs/versions/${{ github.ref_name }}/index.md
132-
133-
134-
cp templates/index-versions.template.md docs/versions/index.md
135-
sed "s/^## \(.*\)$/## \1 \n\n[➔ Lien vers la documentation](\1\/index.md) /" artifact/CHANGELOG.md >>docs/versions/index.md
136-
137-
sed "s#__version__#${{ github.ref_name }}#" templates/latest.template.html >docs/versions/latest/index.html
138-
rm -r artifact
139-
140-
- name: Publish on gh-pages branch
110+
- name: Publish documentation
111+
if: "matrix.os == 'ubuntu-20.04'"
141112
run: |
142113
git config user.name github-actions
143114
git config user.email github-actions@github.com
144-
git add -v docs/versions/${{ github.ref_name }}/ docs/versions/latest/ docs/versions/index.md mkdocs.yml
145-
git commit -m "Add documentation for version ${{ github.ref_name }}"
146-
git push
115+
cd target/
116+
mike deploy --push --update-aliases --branch gh-pages -t "Version ${{ github.ref_name }}" ${{ github.ref_name }} latest
117+
mike set-default --push --branch gh-pages ${{ github.ref_name }}
118+
147119
148120
delete_version:
149121
name: Remove release and tag if error occured

‎.github/workflows/build-docs.yaml‎

Lines changed: 0 additions & 67 deletions
This file was deleted.

‎.github/workflows/pr-auto-labeler.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: "🏷 PR Labeler"
22
on:
3-
- pull_request_target
3+
- pull_request
44

55
permissions:
66
contents: read
@@ -10,6 +10,6 @@ jobs:
1010
triage:
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/labeler@v4
13+
- uses: actions/labeler@v5
1414
with:
1515
repo-token: "${{ secrets.GITHUB_TOKEN }}"

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
build
22
dist
3-
.vscode
3+
target
4+
.vscode

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 1.3.1
2+
3+
### [Fixed]
4+
5+
* `S3Context` : pour éviter des conflits dans une utilisation multithreadée, la sortie de la fonction HMAC (openssl) est dédiée.
6+
17
## 1.3.0
28

39
### [Added]

‎CMakeLists.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ endif(UNITTEST_ENABLED)
131131
if(DOC_ENABLED)
132132

133133
set(DOXYGEN_DOXYFILE_ENCODING UTF-8)
134-
set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/dist)
134+
set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/target/docs)
135135
set(DOXYGEN_OUTPUT_LANGUAGE french)
136136
set(DOXYGEN_INPUT_ENCODING UTF-8)
137137
set(DOXYGEN_IMAGE_PATH docs/images)

‎docs/CHANGELOG.hdr.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
hide:
3+
- navigation
4+
---

‎docs/CONTRIBUTING.hdr.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
hide:
3+
- navigation
4+
---

‎docs/README.hdr.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
hide:
3+
- navigation
4+
---

‎docs/documentation.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
7+
# Documentation technique
8+
9+
<iframe src="../html/index.html"></iframe>

0 commit comments

Comments
 (0)