Skip to content

Commit 3622d8d

Browse files
committed
feat: publish docs with releases
1 parent a841d62 commit 3622d8d

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

.github/workflows/release_ruleset.yaml

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@ on:
5959
default: true
6060
description: Indicator of whether or not this is a prerelease.
6161
type: boolean
62+
docs:
63+
default: false
64+
description: |
65+
Indicator of whether or not to generate starlark documentation from bzl_library targets.
66+
When true, an additional release artifact will be produced, which is an archive file of the binary protobuf files
67+
output by the [starlark_doc_extract](https://bazel.build/reference/be/general#starlark_doc_extract) rule.
68+
type: boolean
6269
draft:
6370
default: false
6471
description: |
@@ -94,7 +101,7 @@ jobs:
94101
# Fetch built artifacts (if any) from earlier jobs, which the release script may want to read.
95102
# Extract into ${GITHUB_WORKSPACE}/artifacts/*
96103
- uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
97-
104+
98105
- name: Build release artifacts and prepare release notes
99106
run: |
100107
if [ ! -f ".github/workflows/release_prep.sh" ]; then
@@ -103,6 +110,22 @@ jobs:
103110
fi
104111
.github/workflows/release_prep.sh ${{ inputs.tag_name || github.ref_name }} > release_notes.txt
105112
113+
- name: Generate starlark documentation
114+
if: inputs.docs
115+
run: |
116+
echo >.bazelversion "7.6.1"
117+
cat >MODULE.bazel <<EOF
118+
module(
119+
name = "rules_oci",
120+
version = "0.0.0",
121+
)
122+
local_path_override(
123+
module_name = "rules_oci",
124+
path = "${{GITHUB_WORKSPACE}}",
125+
)
126+
EOF
127+
bazel build @rules_oci//oci:defs.docs-as-proto
128+
106129
- uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 #v4.6.0
107130
id: upload-release-files
108131
with:

0 commit comments

Comments
 (0)