Skip to content

Commit

Permalink
SEED: Add facilitators to metadata and generated table
Browse files Browse the repository at this point in the history
Accept facilitator as an argument to the pw_seed build template and
update the SEED process to include setting it.

Change-Id: I869cce771b30bdc14dd3407810c9f57d0efedde1
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/185932
Reviewed-by: Armando Montanez <[email protected]>
Commit-Queue: Auto-Submit <[email protected]>
Pigweed-Auto-Submit: Alexei Frolov <[email protected]>
Presubmit-Verified: CQ Bot Account <[email protected]>
  • Loading branch information
frolv authored and CQ Bot Account committed Dec 21, 2023
1 parent baed4c8 commit 8d60197
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 0 deletions.
4 changes: 4 additions & 0 deletions pw_docgen/py/pw_docgen/seed.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ def _main():
' - Title',
' - Status',
' - Author',
' - Facilitator',
]

# RST toctree including each SEED's source file.
Expand All @@ -91,12 +92,15 @@ def _main():
title = f':ref:`{meta["title"]} <seed-{meta["number"]}>`'
seed_toctree.append(Path(meta["rst_file"]).stem)

facilitator = meta.get('facilitator', 'Unassigned')

seed_table.extend(
[
f' * - {meta["number"]}',
f' - {title}',
f' - {_status_badge(meta["status"])}',
f' - {meta["author"]}',
f' - {facilitator}',
]
)

Expand Down
13 changes: 13 additions & 0 deletions seed/0001-the-seed-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,19 @@ Suppose you'd like to propose a new Pigweed RPC Over Smoke Signals protocol.
through the process. The SEED facilitator will be added as a reviewer on
your SEED and will be your primary point of contact on the Pigweed team.

Update the status of your SEED to ``"Open for Comments"`` and set the
assigned facilitator in its build target.

.. code-block::
pw_seed("5309") {
changelist = 987654
title = "pw_rpc Over Smoke Signals"
status = "Open for Comments"
author = "Your Name"
author = "Your Facilitator"
}
#. Create a thread for your SEED in the ``#seed`` channel of Pigweed's
`Discord server <https://discord.gg/M9NSeTA>`_.

Expand Down
18 changes: 18 additions & 0 deletions seed/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -22,125 +22,143 @@ pw_seed("0001") {
title = "The SEED Process"
status = "Meta"
author = "The Pigweed Authors"
facilitator = "N/A"
}

pw_seed("0002") {
sources = [ "0002-template.rst" ]
title = "SEED Template"
status = "Meta"
author = "The Pigweed Authors"
facilitator = "N/A"
}

pw_seed("0101") {
sources = [ "0101-pigweed.json.rst" ]
title = "pigweed.json"
status = "Accepted"
author = "Rob Mohr"
facilitator = "Ted Pudlik"
}

pw_seed("0102") {
sources = [ "0102-module-docs.rst" ]
title = "Consistent Module Documentation"
status = "Accepted"
author = "Chad Norvell"
facilitator = "Kayce Basques"
}

pw_seed("0103") {
changelist = 133971
title = "pw_protobuf: Past, present, and future"
status = "On Hold"
author = "Alexei Frolov"
facilitator = "Armando Montanez"
}

pw_seed("0104") {
sources = [ "0104-display-support.rst" ]
title = "Display Support"
status = "Accepted"
author = "Chris Mumford"
facilitator = "Anthony DiGirolamo"
}

pw_seed("0105") {
sources = [ "0105-pw_tokenizer-pw_log-nested-tokens.rst" ]
title = "Nested Tokens and Tokenized Log Arguments"
status = "Accepted"
author = "Gwyneth Chen"
facilitator = "Wyatt Hepler"
}

pw_seed("0106") {
changelist = 155430
title = "Project Template"
status = "On Hold"
author = "Armando Montanez"
facilitator = "Kayce Basques"
}

pw_seed("0107") {
sources = [ "0107-communications.rst" ]
title = "Pigweed Communications"
status = "Accepted"
author = "Wyatt Hepler"
facilitator = "Carlos Chinchilla"
}

pw_seed("0108") {
sources = [ "0108-pw_emu-emulators-frontend.rst" ]
title = "Emulators Frontend"
status = "Accepted"
author = "Octavian Purdila"
facilitator = "Armando Montanez"
}

pw_seed("0109") {
sources = [ "0109-comms-buffers.rst" ]
title = "Communication Buffers"
status = "Accepted"
author = "Taylor Cramer"
facilitator = "Erik Gilling"
}

pw_seed("0110") {
sources = [ "0110-memory-allocation-interfaces.rst" ]
title = "Memory Allocation Interfaces"
status = "Accepted"
author = "Alexei Frolov"
facilitator = "Taylor Cramer"
}

pw_seed("0111") {
sources = [ "0111-build-systems.rst" ]
title = "Make Bazel Pigweed's Primary Build System"
status = "Accepted"
author = "Ted Pudlik"
facilitator = "Armando Montanez"
}

pw_seed("0112") {
sources = [ "0112-async-poll.rst" ]
title = "Async Poll Model"
status = "Accepted"
author = "Taylor Cramer"
facilitator = "Wyatt Hepler"
}

pw_seed("0113") {
sources = [ "0113-bazel-cc-toolchain-api.rst" ]
title = "Add modular Bazel C/C++ toolchain API"
status = "Accepted"
author = "Armando Montanez"
facilitator = "Ted Pudlik"
}

pw_seed("0114") {
sources = [ "0114-channels.rst" ]
title = "Channels"
status = "Accepted"
author = "Wyatt Hepler"
facilitator = "Carlos Chinchilla"
}

pw_seed("0115") {
changelist = 176760
title = "pw_sensor: Sensors"
status = "Open for Comments"
author = "Yuval Peress"
facilitator = "Taylor Cramer"
}

pw_seed("0116") {
changelist = 177696
title = "pw_net Sockets"
status = "Open for Comments"
author = "Wyatt Hepler"
facilitator = "Taylor Cramer"
}

pw_seed("0117") {
Expand Down
6 changes: 6 additions & 0 deletions seed/seed.gni
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ template("pw_seed_index") {
#
# authors (required): Comma-separated list of SEED authors.
#
# facilitator (optional): Pigweed team member facilitating the SEED.
#
# status (required): Status of the SEED. One of:
# Draft, Open for Comments, Last Call, Accepted, Rejected, On Hold,
# Deprecated, Superseded, Meta
Expand All @@ -99,6 +101,10 @@ template("pw_seed") {
title = invoker.title
status = invoker.status
author = invoker.author

if (defined(invoker.facilitator)) {
facilitator = invoker.facilitator
}
}

if (_has_sources) {
Expand Down

0 comments on commit 8d60197

Please sign in to comment.