Skip to content

Webhooks

Jump to bottom
steveri edited this page Apr 5, 2024 · 17 revisions

Buildkite pipelines attach to github repos by means of webhooks. Here, we list all the webhooks found in our two buildkite repositories Stanford-AHA and Tapeout-AHA. Some of the pipelines are VALID in that they are currently being maintained and used. The remaining pipelines are disabled and/or inactive and should probably be deleted...

The remainder of this document is laid out as follows:

Stanford-AHA Pipelines
REPO Stanford-aha repo is here: https://buildkite.com/stanford-aha
WEBHOOK The webhook for e.g. pipeline "aha-flow" can be found at
https://buildkite.com/stanford-aha/aha-flow/settings/setup/github

VALID stanford-aha pipelines

    PIPELINE          GITHUB REPO         WEBHOOK    WHAT IT DOES
    ---------------   ------------------  --------   -----------------------
    aha-submod-flow   StanfordAHA/aha     55a73168   redirects to aha-flow
    aha-flow          StanfordAHA/aha     36f18efb   gold tests, regressions
    garnet            StanfordAHA/garnet  6e6fc882   lint, aha regressions
    fault             leonardt/fault      d839ecaa   pytests, codecov maybe
    lassen            StanfordAHA/lassen  bd3ca67e   run.sh,coveralls
    pysv              Kuree/pysv          58c69406  


NOTES
.  aha-submod-flow  Triggered by submods; rewrites trigger info and redirects to aha-flow pipeline
.         aha-flow  Skips regressions if triggered by Garnet PR b/c redundant with tapeout-aha/garnet
.            fault  Last build was Dec 2023, 3 months ago ish
.           lassen  Has been FAILING steadily since Nov 2023
.             pysv  Most recent PASS = feb 2024, push-to-master from keyi maybe
TODO
. File an issue on the lassen pipeline, request a fix.

DEAD stanford-aha pipelines

  PIPELINE         GITHUB REPO              WEBHOOK   STATUS       WHAT IT DOES
  --------------   ----------------------   --------  ---------    ------------------------
  anasymod         sgherbst/anasymod        199e2585  Disabled     pipeline.yml [1]
  butterphy        StanfordVLSI/ButterPHY   b68c3953  No builds    LEGACY pytests [2]
  dragonphy        StanfordVLSI/dragonphy   b58c0b97  No builds    pipeline.yml
  dragonphy2       StanfordVLSI/dragonphy2  ad33aab8  Disabled     pipeline.yml
  garnetflow       StanfordAHA/GarnetFlow   b11054df  No builds    YAML run.sh [3]
  jtag-test        sgherbst/jtag_test       6f9b3b81  Disabled     pipeline.yml
  kratos-runtime   Kuree/kratos-runtime     dc4295f3  No builds    YAML pytests
  svreal           sgherbst/svreal          f78f1e38  FAILING      pipeline.yml [4]


NOTES
[1]"pipeline.yml" runs "regress.sh" e.g. see https://github.com/sgherbst/anasymod/.buildkite/pipeline.yml
[2] LEGACY: legacy steps in buildkite repo https://buildkite.com/stanford-aha/butterphy/steps
[3] YAML: yaml steps in buildkite repo e.g. https://buildkite.com/stanford-aha/lassen/settings/steps
[4] FAILING: svreal pipeline has only been triggered five times in recorded history;
each build ran for 4 weeks and FAILED. The most recent build was Jul 2023.
TODO
File issues on all the disabled pipelines!

Tapeout-AHA Pipelines
REPO Tapeout-aha repo is here: https://buildkite.com/tapeout-aha
WEBHOOK The webhook for e.g. pipeline "fullchip" can be found at
https://buildkite.com/tapeout-aha/fullchip/settings/setup/github

VALID tapeout-aha pipelines

  PIPELINE    GITHUB REPO         WEBHOOK  WHAT IT DOES
  checkin_gf  StanfordAHA/garnet  adee71e  GF physical design tests
  fullchip    StanfordAHA/garnet  27e9132  Full-chip Amber physical design (PD)
  mflowgen    StanfordAHA/garnet  45bdf84  RTL gold, Amber ptile/mtile/gtile PD

**NOTES**
. "checkin_gf" is currently disabled for lack of maintenance
. "fullchip" currently runs once a week on Fridays

DEAD tapeout-aha pipelines

  PIPELINE    GITHUB REPO         WEBHOOK  Status
  ---------   ------------------  -------  -----------------------------
  power       StanfordAHA/garnet  483f328  Dead but not gone (yet)
  pe          StanfordAHA/garnet  3bfd443  Dead and gone
  top         StanfordAHA/garnet  f585df6  Dead and gone
  shale       hofstee/shale       b099802  Dead and will be deleted SOON
  shale-rtl   hofstee/shale       52df386  Dead and will be deleted SOON


NOTES
The "power" pipeline invokes "$GARNET/.buildkite/pipeline_power.yml,"
which no longer exists, and which relied on shell scripts
"$GARNET/.buildkite/{gen,syn,report}.sh," none of which currently exist.
.
TODO:
File garnet issue and delete buildkite tapeout-aha/power pipeline.
.
DONE:
Deleted pipelines "shale," "shale-rtl," see https://github.com/hofstee/shale/issues/12.

Aha-Repo Webhooks

    HOOK URL   ACTIONS               HOOK:DESTINATION
    ---------  -------------         ------------------------------
    176824029  dep,push,pull         36f18efb
    192319827  branch/tag create/del https://readthedocs.org/api/v2/webhook/aha/115203/
               push,pull


NOTES
"readthedocs" appears to be a long-unused documentation-generating program.
It apparently uses a tool called "sphinx" to produce HTML documentation
using templated information in the aha repo's "doc/" directory.
.
Also see kiwi:~steveri/0notes/readthedocs.txt, and upcoming aha github issue.

Garnet-Repo Webhooks

Garnet webhooks can be found e.g. here: https://github.com/StanfordAHA/garnet/settings/hooks/131214873

Note: "Recent deliveries" only shows payloads for the most recent three days. See e.g. https://github.com/StanfordAHA/garnet/settings/hooks/262143997?tab=deliveries

Hook destinations expand to e.g. https://webhook.buildkite.com/deliver/3131f...

    HOOK URL      ACTIONS          HOOK     DESTINATION REPO/PIPELINE
    ---------     -------------    -----    --------------------------------
    131214873     dep,push,pull    3131f    ??? (TBD)
    132290951     dep,push,pull    f585d    tapeout-aha/ top [1] (TBD)
    134233154     dep,push,pull    3bfd4    tapeout-aha/ pe [1] (TBD)
    141345094     dep,push,pull    483f3    tapeout-aha/ power (TBD)
    137417398     push             45bdf    tapeout-aha/ mflowgen
    238893740     dep,push,pull    27e91    tapeout-aha/ fullchip [2]
    262143997     dep,push,pull    6e6fc   stanford-aha/ garnet
    347565683     dep,push,pull    adee7    tapeout-aha/ checkin_gf
    432143515     dep,push,pull    55a73   stanford-aha/ aha-submod-flow [3]


NOTES
(TBD) "To Be Deleted," these hooks are no longer useful.
.
[1] "Last delivery was unsuccessful." (Because "top" and "pe " pipelines
have been deleted from buildkite.) (These hooks should be deleted.)
.
[2] The "fullchip" pipeline is disabled at the buildkite end ("Disable all GitHub
activity" -- https://buildkite.com/tapeout-aha/fullchip/settings/repository).
Instead of github events, the pipeline triggers on a once-weekly schedule.
.
[3] "aha-submod-flow" automatically triggers "aha-flow" in the aha repo
.
MORE NOTES
There are nine hooks.  Two of the nine are dead links that should
be removed ("pe" and "top"). That leaves seven. But pull requests
only show four triggered buildkite pipelines: aha-flow (triggered
by aha-submod-flow), checkin-gf, garnet, and mflowgen. This means
"3131f", "power", and "fullchip" are somehow not responding maybe?
.
We know the "power" pipeline is broken (see above), and will
probably be deleted soon.
.
Ah. "fullchip" settings say "Disable all GitHub activity"
https://buildkite.com/tapeout-aha/fullchip/settings/repository
.
TODO
* File issues and delete garnet hooks 132290951, 134233154 that lead to deleted pipelines pe, top
* File issues and delete apparently-orphaned buildkite hook 3131f, see who squawks.
Clone this wiki locally