Repository navigation
47 lines (43 loc) · 2.14 KB
/
Copy pathperformance.yml
File metadata and controls
47 lines (43 loc) · 2.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
name: Performance measurement (manual guide)
# Performance measurement is MANUAL today. This workflow runs no benchmark,
# checks out no source, executes no repository code, reads no secret and
# uploads no artifact. It exists so the performance path keeps a permanent,
# findable name and points to the single home for the manual journey:
# docs/performance/README.md.
#
# TODO (owner-only, not implemented): a dedicated self-hosted runner on an
# exclusive machine, registered by the owner, with dispatch restricted to the
# owner, building one exact reviewed baseline and candidate under one exclusive
# target directory and resource envelope, with publication of a public summary
# kept as a separate explicit step. Not an existing capability: runner
# admission, resource isolation, security controls and the measurement steps
# are still to be built. Until the owner authorizes and builds that, do not add
# a self-hosted runner, secrets, write permissions, fork execution or a
# schedule here, and do not make this a required check.
#
# DORMANT PLACEHOLDER: this workflow cannot run today. Its only active trigger
# is a push filter that ignores every branch and every tag, so no push, tag,
# pull request, schedule or dispatch ever starts it and it never reports a
# status. Its only step exits nonzero, so a wrongly enabled run reports a
# failure, never a green result. Enabling it later is owner-controlled and
# needs the runner admission, resource isolation, security controls and
# measurement steps described above; changing a trigger or `runs-on` alone is
# not enough.
permissions:
contents: read
on:
push:
branches-ignore: ['**']
tags-ignore: ['**']
# TODO (owner-controlled future enablement): uncomment only once the
# admission, isolation, security and measurement work above exists.
# workflow_dispatch:
jobs:
manual-performance-guide:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: Refuse to report a measurement that did not run
run: |
echo 'No measurement ran and this is not a performance result; the manual journey is in docs/performance/README.md.' | tee -a "$GITHUB_STEP_SUMMARY"
exit 1