Github Actions for smart contracts

A Github Action for smart contracts which:

• builds the wasm files
• runs both the rust and go testing scenarios
• does a clippy check
• provides a report containing details about the smart contracts

Usage of contracts.yml

Standard build

Create a new file under .github/workflows/actions.yml with the following contents:

name: CI

on:
  push:
    branches:
      - main
  pull_request:

permissions:
  checks: write
  pull-requests: write

jobs:
  contracts:
    name: Contracts
    uses: multiversx/mx-sc-actions/.github/workflows/[email protected]
    with:
      rust-toolchain: nightly-2023-12-11
    secrets:
      token: ${{ secrets.GITHUB_TOKEN }}

Preferably use the latest version available from here: https://github.com/multiversx/mx-sc-actions/releases.

This uses a fixed version of rust. See contracts.yml for more details on which other arguments are supported.

Main branch notes

When using the action, pay attention to the branch naming under the push event and use either main or master accordingly. Using the wrong main branch name will cause the github actions build to be skipped, without displaying an error message.

Using more than one base branch

As an alternative, when more than one branch is used as a base branch for pull requests, the following can be used instead:

on:
  push:
  pull_request:

Note, however, that this runs the build multiple times for each commit.

Private repositories permissions

For private repositories, read-only contents access has to be granted as well, so the permissions would be:

permissions:
  checks: write
  contents: read
  pull-requests: write

Additional options

Usage of reproducible-build.yml

See reproducible-build.yml.

Configuration entries

The following configuration entries are available:

• image_tag: the desired Docker image tag to be used for the reproducible contract build. The available tags are listed here.
• project_path: the path to the project (workspace) containing the contracts to build. If not specified, the repository folder is used.
• contract_name: a specific contract to be built. If not specified, all contracts in the workspace (repository) are built.
• create_release: whether to create a new release (and upload the build artifacts as assets).
• attach_to_existing_release: whether to upload the build artifacts on an existing release. This only works if the current github.ref_name (of the executing workflow) is associated with an existing release.

Note that create_release and attach_to_existing_release are mutually exclusive.

Creating a release from scratch

At times, you might want to create a release directly from a Github Workflow. In order to do so, follow this example:

name: Create release, build contracts, upload assets

on:
  workflow_dispatch:

permissions:
  contents: write

jobs:
  build:
    uses: multiversx/mx-sc-actions/.github/workflows/[email protected]
    with:
      image_tag: v1.2.3 # this is an example; see above
      create_release: true

Building on an existing release

In order to configure your workflow for building the contracts and uploading the output on a newly created (published) release, do as follows:

name: On new release, build contracts, upload assets

permissions:
  contents: write

on:
  release:
    types: [published]

jobs:
  build:
    uses: multiversx/mx-sc-actions/.github/workflows/[email protected]
    with:
      image_tag: v1.2.3 # this is an example; see above
      attach_to_release: true

Running reproducible builds on pull requests

In order to run the reproducible builds on a pull request, without creating or editing a GitHub release, do as follows:

name: Build contracts

on:
  pull_request:

permissions:
  contents: write

jobs:
  build:
    uses: multiversx/mx-sc-actions/.github/workflows/[email protected]
    with:
      image_tag: v1.2.3 # this is an example; see above

Once the workflow finishes, the build artifacts will be found as workflow artifacts.

Now, let's select a single contract to be built:

name: Build contracts

on:
  pull_request:

permissions:
  contents: write

jobs:
  build:
    uses: multiversx/mx-sc-actions/.github/workflows/[email protected]
    with:
      image_tag: v1.2.3 # this is an example; see above
      contract_name: adder