DFINITY GitHub CI Tools

Shared GitHub workflows and actions for DFINITY repositories.

Workflows

• Check commit messages
• Generate changelog

Actions

• Approve pull request
• Bump version
• Check commit messages
• Check pull request title
• Create pull request
• Generate changelog
• Generate release notes
• Setup Commitizen
• Setup pnpm
• Setup Python

Conventions

Required actions

Suffix required actions with :required to make it easier to determine which actions are required and which aren't.

Example:

name: 'My Action:required'

Contributing

Check out the contribution guidelines.

Setup

• Install fnm.

  curl -fsSL https://get.pnpm.io/install.sh | sh -

• Install the correct version of nodejs.

  fnm install

• Enable the correct version of nodejs.

  fnm use

• Set up the correct version of pnpm.

  corepack enable

• Install dependencies:

  pnpm i

Updating pnpm

To update the version of pnpm that is used:

corepack use [email protected]

Building

Actions are built locally and the built files are committed to the repository. To build the actions, run:

pnpm build

The GitHub actions pipeline will attempt to build the actions and check if there are any differences between the built files and those that are committed to the repository. If there are any differences, the pipeline will fail.