Skip to content

Commit 2dcfa80

Browse files
Adding 'module' way to build docs (#16)
Upgrading dependencies Changing current build to 'latest' Adding 'release' build Adding new commands to README
1 parent b0119ee commit 2dcfa80

File tree

3 files changed

+45
-13
lines changed

3 files changed

+45
-13
lines changed

MODULE.bazel

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ bazel_dep(name = "rules_pkg", version = "1.0.1")
2323
# Python version
2424
#
2525
###############################################################################
26-
bazel_dep(name = "rules_python", version = "1.0.0")
26+
bazel_dep(name = "rules_python", version = "1.4.1")
2727

2828
PYTHON_VERSION = "3.12"
2929

@@ -36,20 +36,21 @@ python.toolchain(
3636
use_repo(python)
3737

3838
# Additional Python rules provided by aspect, e.g. an improved version of
39-
bazel_dep(name = "aspect_rules_py", version = "1.0.0")
39+
bazel_dep(name = "aspect_rules_py", version = "1.4.0")
4040
bazel_dep(name = "buildifier_prebuilt", version = "7.3.1")
4141

4242
###############################################################################
4343
#
4444
# Generic linting and formatting rules
4545
#
4646
###############################################################################
47-
bazel_dep(name = "aspect_rules_lint", version = "1.3.1")
47+
bazel_dep(name = "aspect_rules_lint", version = "1.4.2")
4848

4949
# Provides, pytest & venv
50-
bazel_dep(name = "score_python_basics", version = "0.3.0")
50+
bazel_dep(name = "score_python_basics", version = "0.3.1")
5151

5252
# Checker rule for CopyRight checks/fixes
5353
bazel_dep(name = "score_cr_checker", version = "0.2.2")
54-
bazel_dep(name = "score_docs_as_code", version = "0.2.2")
5554
bazel_dep(name = "score_format_checker", version = "0.1.1")
55+
bazel_dep(name = "score_platform", version = "0.1.1")
56+
bazel_dep(name = "score_docs_as_code", version = "0.2.6")

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# process_description
2+
23
S-CORE process description
34

45
## Overview
5-
The S-CORE process model aims to establish organization rules for developing open source software in the automotive industry, which can be used in safety and security context.
66

7+
The S-CORE process model aims to establish organization rules for developing open source software in the automotive industry, which can be used in safety and security context.
78

89
## Features
910

1011
The process model provide processes, which conform to state-of the art standards
12+
1113
- ASPICE PAM 4.0
1214
- ISO 26262
1315
- ISO/SAE 21434
@@ -17,20 +19,39 @@ The process model provide processes, which conform to state-of the art standards
1719

1820
#### Run a documentation build:
1921

22+
#### Integrate latest score main branch
23+
2024
```bash
21-
bazel run //process:incremental
22-
bazel build //process:docs
23-
bazel run //process:ide_support
25+
bazel run //process:incremental_latest
26+
bazel build //process:docs_latest
27+
```
28+
29+
#### Integrate latest score release
30+
31+
This should also work with proxy configuration if latest is not working.
32+
33+
```bash
34+
bazel run //process:incremental_release
35+
bazel build //process:docs_release
2436
```
2537

2638
#### Access your documentation at:
2739

2840
- `_build/` for incremental
2941
- `bazel-bin/bazel-bin/<BUILD FILE FOLDER NAME>/docs/_build/html`
3042

43+
#### Getting IDE support
44+
45+
Create the virtual environment via `bazel run //process:ide_support`.\
46+
If your IDE does not automatically ask you to activate the newly created environment you can activate it.
47+
48+
- In VSCode via `ctrl+p` => `Select Python Interpreter` then select `.venv/bin/python`
49+
- In the terminal via `source .venv/bin/activate`
50+
3151
#### Format your documentation with:
3252

3353
```bash
3454
bazel test //:format.test
3555
bazel run //:format.fix
36-
```
56+
```
57+

process/BUILD

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,22 @@ docs(
2424
conf_dir = "process", # Where 'conf.py' is
2525
docs_targets = [
2626
{
27-
"suffix": "", # latest main branch documentation build
27+
"suffix": "latest", # latest main branch documentation build
2828
"external_needs_info": [
2929
{
30-
"base_url": "https://eclipse-score.github.io/score/main",
30+
"base_url": "https://eclipse-score.github.io/score/main/",
3131
"json_url": "https://eclipse-score.github.io/score/main/needs.json",
32-
"version": "0.1",
32+
"id_prefix": "score_",
33+
},
34+
],
35+
},
36+
{
37+
"suffix": "release", # The version imported from MODULE.bazel
38+
"target": ["@score_platform//docs:docs_needs"],
39+
"external_needs_info": [
40+
{
41+
"base_url": "https://eclipse-score.github.io/score/main/",
42+
"json_path": "/score_platform~/docs/docs_needs/_build/needs/needs.json",
3343
"id_prefix": "score_",
3444
},
3545
],

0 commit comments

Comments
 (0)