Skip to content

Commit 480877e

Browse files
Docs-as-Code 1.0.1 Upgrade (#32)
This PR will enable Module Template to use DaC 1.0.1 - Upgrades the bazel version to 8.3 - Upggrades several dependencies - Changed command to build documentaiton in the workflows
1 parent 4a56c1b commit 480877e

File tree

6 files changed

+14
-32
lines changed

6 files changed

+14
-32
lines changed

.bazelversion

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.4.0
1+
8.3.0

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ jobs:
3939

4040
with:
4141
# the bazel-target depends on your repo specific docs_targets configuration (e.g. "suffix")
42-
bazel-target: "//docs:incremental -- --github_user=${{ github.repository_owner }} --github_repo=${{ github.event.repository.name }}"
42+
bazel-target: "//:docs -- --github_user=${{ github.repository_owner }} --github_repo=${{ github.event.repository.name }}"
4343
retention-days: 3

BUILD

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
# *******************************************************************************
1313
load("@score_cr_checker//:cr_checker.bzl", "copyright_checker")
1414
load("@score_dash_license_checker//:dash.bzl", "dash_license_checker")
15+
load("@score_docs_as_code//:docs.bzl", "docs")
1516
load("@score_format_checker//:macros.bzl", "use_format_targets")
16-
load("@score_python_basics//:defs.bzl", "score_virtualenv")
1717
load("@score_starpls_lsp//:starpls.bzl", "setup_starpls")
1818
load("//:project_config.bzl", "PROJECT_CONFIG")
1919

@@ -22,12 +22,6 @@ setup_starpls(
2222
visibility = ["//visibility:public"],
2323
)
2424

25-
score_virtualenv(
26-
name = "ide_support",
27-
reqs = [],
28-
venv_name = ".venv",
29-
)
30-
3125
copyright_checker(
3226
name = "copyright",
3327
srcs = [
@@ -50,3 +44,7 @@ dash_license_checker(
5044

5145
# Add target for formatting checks
5246
use_format_targets()
47+
48+
docs(
49+
source_dir = "docs",
50+
)

MODULE.bazel

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ bazel_dep(name = "googletest", version = "1.14.0")
3333
bazel_dep(name = "rules_rust", version = "0.56.0")
3434

3535
# Checker rule for CopyRight checks/fixs
36-
bazel_dep(name = "score_cr_checker", version = "0.2.2")
37-
bazel_dep(name = "score_python_basics", version = "0.3.0")
36+
bazel_dep(name = "score_cr_checker", version = "0.3.1")
37+
bazel_dep(name = "score_python_basics", version = "0.3.4")
3838
bazel_dep(name = "score_starpls_lsp", version = "0.1.0")
3939

4040
# C/C++ rules for Bazel
@@ -58,8 +58,8 @@ bazel_dep(name = "score_dash_license_checker", version = "0.1.2")
5858

5959
# Format checker
6060
bazel_dep(name = "score_format_checker", version = "0.1.1")
61-
bazel_dep(name = "aspect_rules_lint", version = "1.0.3")
62-
bazel_dep(name = "buildifier_prebuilt", version = "7.3.1")
61+
bazel_dep(name = "aspect_rules_lint", version = "1.4.4")
62+
bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2")
6363

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

docs/BUILD

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

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
2222

2323
project = "Module Template Project"
24+
project_url = "https://eclipse-score.github.io/module_template/"
25+
project_prefix = "MODULE_TEMPLATE_"
2426
author = "S-CORE"
2527
version = "0.1"
2628

0 commit comments

Comments
 (0)