Skip to content

Commit 17a495a

Browse files
AlexKehayovAlexKehayov
committed
Merge branch 'main' into 21605-timeout-onnext-oncomplete
# Conflicts: # hedera-node/hedera-app/src/main/java/com/hedera/node/app/blocks/impl/streaming/BlockNodeConnection.java # hedera-node/hedera-app/src/test/java/com/hedera/node/app/blocks/impl/streaming/BlockNodeConnectionTest.java
2 parents 8fe9ebc + 1d6ce2b commit 17a495a

File tree

136 files changed

+4571
-1316
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+4571
-1316
lines changed

‎.github/workflows/docs/naming-standards.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# GitHub Action Naming Standards
2+
3+
This document outlines the conventions and best practices for naming GitHub workflow files,
4+
organizing workflow directories, and structuring workflow definitions.
5+
It is intended to ensure consistency, readability, and maintainability across all repository workflows.
6+
7+
## Workflow Naming Standards:
8+
9+
### Workflow Name
10+
11+
`ddd: [XXXX] <my-21-char-name>`
12+
13+
### Workflow Name Description
14+
15+
- 3-digit prefix (000 to 999)
16+
17+
| Prefix | Category / Description | Notes / Subcategory |
18+
|--------|--------------------------------|-----------------------------------|
19+
| 000 | User-centric workflows | Sorted by priority/use |
20+
| 100 | Operational workflows | Manual-run RE flows |
21+
| 200 | CITR workflows (all workflows) | |
22+
| 200 | CITR manual run | Adhoc runs |
23+
| 220 | CITR daily runs | Automatic daily runs |
24+
| 240 | CITR longer runs | Multi-day runs |
25+
| 300 | Trigger-based `main` workflows | |
26+
| 400 | TBD | |
27+
| 500 | TBD | |
28+
| 600 | TBD | |
29+
| 700 | TBD | |
30+
| 800 | Reusable workflows | |
31+
| 900 | Cron tasks | Prefixed by 900 to sort to bottom |
32+
33+
- Followed by `: ` (colon and a space)
34+
35+
- Followed by square-bracket notation `[XXXX] ` followed by a space
36+
37+
| Workflow Code | Description |
38+
|---------------|---------------------------------------------------------------------------------------|
39+
| `[USER]` | Called by user directly via workflow dispatch |
40+
| `[FLOW]` | Triggered through some manner (PR Target, Branch Push, or Tag Push) |
41+
| `[CALL]` | Reusable workflow (`workflow_call`) |
42+
| `[CRON]` | Scheduled workflow (`schedule`) |
43+
| `[DISP]` | Internal dispatchable (workflow dispatch triggered by other workflows, not end users) |
44+
45+
- Followed by the name of the workflow, maximum of 21 characters
46+
47+
- Workflow Naming Notes:
48+
49+
- Use proper casing
50+
- Separator used should be spaces
51+
52+
### Example Workflow Name
53+
54+
Example: Suppose we have a user-centric workflow that is the highest priority workflow in the repo. This workflow is
55+
for performing status checks.
56+
57+
Name of the Workflow: `000: [USER] Status Checks`
58+
59+
| Numeric Prefix | `: ` | Workflow Code | Name of Workflow |
60+
|----------------|------|---------------|------------------|
61+
| `000` | `: ` | `[USER]` | `Status Checks` |
62+
63+
## File Naming Standards:
64+
65+
### File Name
66+
67+
`ddd-xxxx-<my-30-char-file-name>.yaml`
68+
69+
### File Name Description
70+
71+
- 3-digit prefix (000 to 999)
72+
73+
| Prefix | Category / Description | Notes / Subcategory |
74+
|--------|--------------------------------|-----------------------------------|
75+
| 000 | User-centric workflows | Sorted by priority/use |
76+
| 100 | Operational workflows | Manual-run RE flows |
77+
| 200 | CITR workflows (all workflows) | |
78+
| 200 | CITR manual run | Adhoc runs |
79+
| 220 | CITR daily runs | Automatic daily runs |
80+
| 240 | CITR longer runs | Multi-day runs |
81+
| 300 | Trigger-based `main` workflows | |
82+
| 400 | TBD | |
83+
| 500 | TBD | |
84+
| 600 | TBD | |
85+
| 700 | TBD | |
86+
| 800 | Reusable workflows | |
87+
| 900 | Cron tasks | Prefixed by 900 to sort to bottom |
88+
89+
- Followed by a hyphen `-`
90+
91+
- Followed by the workflow code (see table below)
92+
93+
| Workflow Code | Description |
94+
|---------------|---------------------------------------------------------------------------------------|
95+
| `user` | Called by user directly via workflow dispatch |
96+
| `flow` | Triggered through some manner (PR Target, Branch Push, or Tag Push) |
97+
| `call` | Reusable workflow (`workflow_call`) |
98+
| `cron` | Scheduled workflow (`schedule`) |
99+
| `disp` | Internal dispatchable (workflow dispatch triggered by other workflows, not end users) |
100+
101+
- Followed by a hyphen `-`
102+
103+
- Followed by the workflow name, maximum of 30 characters
104+
105+
- Followed by`.yaml`
106+
107+
- File Naming Notes:
108+
109+
- All letters in filename should be lowercase
110+
- Separator used should be a hyphen
111+
- No special characters are allowed in filename
112+
113+
### Example File Name
114+
115+
Example: Suppose we have a user-centric workflow that is the highest priority workflow in the repo. This workflow is
116+
for performing status checks. Note hyphens are used as separators in the workflow.
117+
118+
Name of the Workflow File: `000-user-status-checks.yaml`
119+
120+
| Numeric Prefix | Workflow Code | Name of Workflow | File Extension |
121+
|----------------|---------------|------------------|----------------|
122+
| `000` | `user` | `status-checks` | `.yaml` |

‎.github/workflows/docs/workflow-manifest.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
| Current File Name | Current Workflow Name | Future File Name | Future Workflow Name |
2+
|-------------------------------------------------------|-------------------------------------------------------------------|------------------|----------------------|
3+
| # Cron | | | |
4+
| zxcron-extended-test-suite.yaml | ZXCron: [CITR] Extended Test Suite | | |
5+
| zxcron-promote-build-candidate.yaml | ZXCron: [CITR] Promote Build Candidate | | |
6+
| node-zxcron-release-branching.yaml | ZXCron: Automatic Release Branching | | |
7+
| zxcron-clean.yaml | CronClean Latitude Namespaces | | |
8+
| zxcron-auto-namespaces-delete.yaml | Delete automation Latitude Namespaces | | |
9+
| node-zxcron-main-fsts-regression.yaml | ZXCron: [Node] Main JRS Tests | | |
10+
| node-zxcron-release-fsts-regression.yaml | ZXCron: [Node] Release JRS Tests | | |
11+
| platform-zxcron-main-jrs-regression.yaml | ZXCron: [Platform] Main JRS Regression | | |
12+
| platform-zxcron-release-jrs-regression.yaml | ZXCron: [Platform] Release JRS Regression | | |
13+
| | | | |
14+
| # REUSABLE | | | |
15+
| zxc-block-node-regression.yaml | ZXC: Block Node Explorer Regression | | |
16+
| zxc-execute-performance-test.yaml | ZXC: [CITR] Execute Performance Test | | |
17+
| zxc-jrs-regression.yaml | ZXC: Regression | | |
18+
| zxc-json-rpc-relay-regression.yaml | ZXC: JSON-RPC Relay Regression | | |
19+
| zxc-mirror-node-regression.yaml | ZXC: Mirror Node Regression | | |
20+
| zxc-publish-production-image.yaml | ZXC: Publish Production Image | | |
21+
| zxc-single-day-longevity-test.yaml | ZXC: [CITR] Single Day Longevity Test | | |
22+
| zxc-single-day-performance-test.yaml | ZXC: [CITR] Single Day Performance Test | | |
23+
| zxc-tck-regression.yaml | ZXC: TCK Regression | | |
24+
| platform-zxc-launch-jrs-workflow.yaml | ZXC: Launch JRS Workflow | | |
25+
| node-zxc-build-release-artifact.yaml | ZXC: [Node] Deploy Release Artifacts | | |
26+
| node-zxc-compile-application-code.yaml | ZXC: [Node] Compile Application Code | | |
27+
| node-zxc-deploy-preview.yaml | ZXC: [Node] Deploy Preview Network Release | | |
28+
| | | | |
29+
| # CICD | | | |
30+
| zxf-collect-workflow-logs.yaml | ZXF: Collect Workflow Run Logs | | |
31+
| zxf-dry-run-extended-test-suite.yaml | ZXF: [CITR] XTS Dry Run | | |
32+
| zxf-prepare-extended-test-suite.yaml | ZXF: [CITR] Prepare Extended Test Suite | | |
33+
| zxf-single-day-canonical-test.yaml | ZXF: [CITR] Single Day Canonical Test (SDCT) | | |
34+
| zxf-single-day-longevity-test-controller-adhoc.yaml | ZXF: [CITR] Adhoc - Single Day Longevity Test Controller | | |
35+
| zxf-single-day-longevity-test-controller.yaml | ZXF: [CITR] Single Day Longevity Test Controller | | |
36+
| zxf-single-day-performance-test-controller-adhoc.yaml | ZXF: [CITR] Adhoc - Single Day Performance Test Controller (SDPT) | | |
37+
| zxf-single-day-performance-test-controller.yaml | ZXF: [CITR] Single Day Performance Test Controller (SDPT) | | |
38+
| | | | |
39+
| # BUILD | | | |
40+
| node-flow-build-application.yaml | Node: Build Application | | |
41+
| node-flow-deploy-adhoc-artifact.yaml | Node: Deploy Adhoc Release | | |
42+
| node-flow-deploy-release-artifact.yaml | ZXF: Deploy Production Release | | |
43+
| | | | |
44+
| # DETERMINISM | | | |
45+
| flow-artifact-determinism.yaml | Artifact Determinism | | |
46+
| zxc-verify-docker-build-determinism.yaml | ZXC: Verify Docker Build Determinism | | |
47+
| zxc-verify-gradle-build-determinism.yaml | ZXC: Verify Gradle Build Determinism | | |
48+
| | | | |
49+
| # RELEASE | | | |
50+
| flow-generate-release-notes.yaml | Generate Release Notes | | |
51+
| flow-increment-next-main-release.yaml | [Release] Increment Version File | | |
52+
| flow-trigger-release.yaml | [Release] Create New Release | | |
53+
| | | | |
54+
| # DEPLOY | | | |
55+
| node-flow-deploy-preview.yaml | Node: Deploy Preview | | |
56+
| node-zxf-deploy-integration.yaml | ZXF: [Node] Deploy Integration Network Release | | |
57+
| | | | |
58+
| # General Testing | | | |
59+
| node-flow-pull-request-checks.yaml | Node: PR Checks | | |
60+
| | | | |
61+
| # JRS Testing | | | |
62+
| platform-pull-request-extended-checks.yaml | Platform: PR Extended Checks | | |
63+
| node-flow-fsts-custom-regression.yaml | Node: FSTS Custom Regression | | |
64+
| node-flow-fsts-daily-interval-01.yaml | ZXF: [Node] FSTS Daily (Interval: 1) | | |
65+
| node-flow-fsts-daily-interval-02.yaml | ZXF: [Node] FSTS Daily (Interval: 2) | | |
66+
| node-flow-fsts-daily-interval-03.yaml | ZXF: [Node] FSTS Daily (Interval: 3) | | |
67+
| node-flow-fsts-daily-interval-04.yaml | ZXF: [Node] FSTS Daily (Interval: 4) | | |
68+
| node-flow-fsts-daily-interval-05.yaml | ZXF: [Node] FSTS Daily (Interval: 5) | | |
69+
| node-flow-fsts-daily-interval-06.yaml | ZXF: [Node] FSTS Daily (Interval: 6) | | |
70+
| node-flow-fsts-daily-regression.yaml | Node: FSTS Daily Regression | | |
71+
| platform-flow-jrs-custom-regression.yaml | Platform: JRS Custom Regression | | |
72+
| platform-flow-jrs-daily-regression.yaml | Platform: JRS Daily Regression | | |
73+
| platform-zxf-jrs-daily-interval-01.yaml | ZXF: [Platform] JRS Daily (Interval: 1) | | |
74+
| platform-zxf-jrs-daily-interval-02.yaml | ZXF: [Platform] JRS Daily (Interval: 2) | | |
75+
| platform-zxf-jrs-daily-interval-03.yaml | ZXF: [Platform] JRS Daily (Interval: 3) | | |
76+
| platform-zxf-jrs-daily-interval-04.yaml | ZXF: [Platform] JRS Daily (Interval: 4) | | |
77+
| platform-zxf-jrs-daily-interval-05.yaml | ZXF: [Platform] JRS Daily (Interval: 5) | | |
78+
| platform-zxf-jrs-daily-interval-06.yaml | ZXF: [Platform] JRS Daily (Interval: 6) | | |
79+
| | | | |
80+
| # QOL | | | |
81+
| zxf-update-gs-state-variable.yaml | ZXF: Update GS_STATE Variable | | |
82+
| flow-pull-request-formatting.yaml | PR Formatting | | |
83+
| node-zxf-snyk-monitor.yaml | ZXF: Snyk Monitor | | |

0 commit comments

Comments
 (0)