Skip to content

Commit d0219ae

Browse files
committed
workflow naming
1 parent 50f4846 commit d0219ae

File tree

5 files changed

+56
-139
lines changed

5 files changed

+56
-139
lines changed

.github/workflows/doc_deployment.yml

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

.github/workflows/doc_preview.yml

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

.github/workflows/documentation-branch-snapshot.yml

Lines changed: 0 additions & 26 deletions
This file was deleted.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Documentation Deployment
2+
3+
on:
4+
push:
5+
branches:
6+
- develop
7+
tags:
8+
- '*'
9+
10+
concurrency:
11+
group: gh-pages
12+
13+
jobs:
14+
deploy-doc:
15+
name: Deploy Stable Documentation
16+
runs-on: ubuntu-latest
17+
permissions:
18+
contents: write
19+
steps:
20+
- name: Configuration
21+
shell: bash
22+
run: |
23+
if [[ "${{ github.event_name }}" != "push" ]]; then
24+
# use tag name
25+
VERSION="${{ github.ref_name }}"
26+
else
27+
# use extracted version from pom.xml on pushes i.e. on develop
28+
VERSION="develop"
29+
fi
30+
echo "version=$VERSION" >> $GITHUB_OUTPUT
31+
32+
- name: Checkout Repository
33+
uses: actions/checkout@v4
34+
with:
35+
ref: ${{ github.ref }}
36+
37+
- name: Deploy Documentation
38+
uses: secure-software-engineering/actions/documentation/deployment@develop
39+
with:
40+
version: ${{ env.version }}
Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
name: PR Documentation Preview
2-
3-
permissions:
4-
pages: write
5-
deployments: write
6-
contents: write
7-
pull-requests: write
1+
name: Documentation Preview
82

93
on:
104
pull_request:
@@ -14,19 +8,24 @@ on:
148
- synchronize
159
- reopened
1610
paths:
17-
- 'mkdocs.yml'
18-
- 'docs/**'
19-
- '.github/workflows/documentation-pr-preview.yml'
11+
- mkdocs.yml
12+
- docs/**
13+
- .github/workflows/documentation-pr-preview.yml
2014

21-
concurrency: pages
15+
concurrency:
16+
group: gh-pages
2217

2318
jobs:
2419
deploy-preview:
20+
name: Preview documentation
2521
runs-on: ubuntu-latest
26-
name: Deploy Documentation Preview
22+
permissions:
23+
contents: write
24+
pull-requests: write # for posting a comment
25+
2726
steps:
28-
- name: sad
29-
uses: secure-software-engineering/actions/documentation/handle-pr-preview@develop
30-
with:
31-
preview-name: ${{ github.base_ref }}
32-
title: "Preview: ${{ github.base_ref }}"
27+
- name: Checkout Repository
28+
uses: actions/checkout@v4
29+
30+
- name: Create Documentation Preview
31+
uses: secure-software-engineering/actions/documentation/pr-preview@develop

0 commit comments

Comments
 (0)