Skip to content

Commit e04e512

Browse files
template: added docs workflows (#17)
Addresses: #16 added reusable workflows for building and publishing documentation uplifted docs-as-code to version 0.2.4 --------- Signed-off-by: Dan Calavrezo <[email protected]>
1 parent 7f364c8 commit e04e512

File tree

5 files changed

+55
-129
lines changed

5 files changed

+55
-129
lines changed

.github/actions/deploy-versioned-pages/action.yml

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

.github/workflows/docs-cleanup.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# *******************************************************************************
2+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
3+
#
4+
# See the NOTICE file(s) distributed with this work for additional
5+
# information regarding copyright ownership.
6+
#
7+
# This program and the accompanying materials are made available under the
8+
# terms of the Apache License Version 2.0 which is available at
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# SPDX-License-Identifier: Apache-2.0
12+
# *******************************************************************************
13+
14+
name: Documentation Cleanup
15+
16+
on:
17+
schedule:
18+
- cron: '0 0 * * *' # Runs every day at midnight UTC
19+
20+
jobs:
21+
docs-cleanup:
22+
uses: eclipse-score/cicd-workflows/.github/workflows/docs-cleanup.yml@main
23+
secrets:
24+
token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# *******************************************************************************
2+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
3+
#
4+
# See the NOTICE file(s) distributed with this work for additional
5+
# information regarding copyright ownership.
6+
#
7+
# This program and the accompanying materials are made available under the
8+
# terms of the Apache License Version 2.0 which is available at
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# SPDX-License-Identifier: Apache-2.0
12+
# *******************************************************************************
13+
14+
name: Documentation
15+
16+
on:
17+
pull_request_target:
18+
types: [opened, reopened, synchronize] # Allows forks to trigger the docs build
19+
push:
20+
branches:
21+
- main
22+
merge_group:
23+
types: [checks_requested]
24+
25+
jobs:
26+
build-docs:
27+
uses: eclipse-score/cicd-workflows/.github/workflows/docs.yml@main
28+
with:
29+
retention-days: 3

MODULE.bazel

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ bazel_dep(name = "aspect_rules_lint", version = "1.0.3")
6262
bazel_dep(name = "buildifier_prebuilt", version = "7.3.1")
6363

6464
#docs-as-code
65-
bazel_dep(name = "score_docs_as_code", version = "0.2.1")
65+
bazel_dep(name = "score_docs_as_code", version = "0.2.4")

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Requirements
3131
------------
3232

3333
.. stkh_req:: Example Functional Requirement
34-
:id: stkh_req__docgen_enabled
34+
:id: stkh_req__docgen_enabled__example
3535
:status: valid
3636
:safety: QM
3737
:reqtype: Functional

0 commit comments

Comments
 (0)