Skip to content

node.md

Latest commit

 

History

History
53 lines (42 loc) · 3.26 KB

node.md

File metadata and controls

53 lines (42 loc) · 3.26 KB
Raw

EVM Node CI

This GitHub Actions workflow builds evm-node and evm-rpc.

Index

  1. Triggers
  2. Inputs
  3. Steps
  4. Outputs
  5. See Also

Triggers

This GitHub action will run under the following circumstances:

  1. When code is pushed.
  2. Workflow dispatch event, a manual CI run, which can be triggered by the "Workflow Dispatch" button in the Actions tab of the GitHub repository, among other means.

Inputs

The inputs for this GitHub action are:

  1. GITHUB_TOKEN - a GitHub Actions intrinsic used to access the repository and other public resources.
  2. TRUSTEVM_CI_APP_ID - the app ID of the trustevm-ci-submodule-checkout GitHub App.
  3. TRUSTEVM_CI_APP_KEY - the private key to the trustevm-ci-submodule-checkout GitHub App.
  4. upload-artifacts - a boolean input that specifies whether or not to upload the artifacts of the build. The default value is false. This can be overridden in manual CI runs.

These inputs are used in various steps of the workflow to perform actions such as authentication, downloading artifacts, configuring the build, and uploading artifacts.

Steps

This workflow performs the following steps:

  1. Attach Documentation
    1. Checkout the repo with no submodules.
    2. Attach an annotation to the GitHub Actions build summary page containing CI documentation.
  2. EVM Node Build
    1. Authenticate to the trustevm-ci-submodule-checkout GitHub app using the AntelopeIO/github-app-token-action action to obtain an ephemeral token.
    2. Checkout the repo and submodules using the ephemeral token.
    3. Build evm-node and evm-rpc using cmake and make.
    4. Upload the build folder to GitHub Actions if the upload-artifacts input is set to true.

Outputs

This workflow produces the following outputs:

  1. Build Artifacts - build.tar.gz containing the built artifacts of evm-node and evm-rpc, if the upload-artifacts input is set to true.

💾️ Build artifacts are only attached on-demand for this pipeline because they are >117 MB each, but we only get 2 GB of cumulative artifact storage in GitHub Actions while evm-node is a private repo. Obtain artifacts by performing a manual build with upload-artifacts set to true.

See Also

For assistance with the CI system, please open an issue in this repo or reach out in the #help-automation channel via IM.

Legal notice
This document was generated in collaboration with ChatGPT from OpenAI, a machine learning algorithm or weak artificial intelligence (AI). At the time of this writing, the OpenAI terms of service agreement §3.a states:

Your Content. You may provide input to the Services (“Input”), and receive output generated and returned by the Services based on the Input (“Output”). Input and Output are collectively “Content.” As between the parties and to the extent permitted by applicable law, you own all Input, and subject to your compliance with these Terms, OpenAI hereby assigns to you all its right, title and interest in and to Output.

This notice is required in some countries.