stellar/actions

This repository contains GitHub Actions and GitHub Actions Workflows that are shared by @stellar repositories.

Warning

The actions and workflows are not suitable for use outside of @stellar repositories. They contain assumptions, features, and behaviors to meet specific requirements the @stellar repositories have that may be harmful in other use cases.

Usage

Limitations

Important

The actions and workflows in this repository are not safe for use in any situation that executes the action or workflow with write access on forks or from other untrusted sources. For example, the pull_request_target event.

Actions

To use an action in this repository in another repository, specify the action in this repo using the uses directive inside a step inside a job, and specify stellar/actions/<action-directory>. For example:

jobs:
  my_job:
    steps:
    - uses: stellar/actions/rust-cache@main

Reusable Workflows

To use a reusable workflow in this repository in another repository, specify the reusable workflow in this repo using the uses directive inside a job, and specify stellar/actions/<path-to-reusable-workflow>. The path used for the workflow must be the .github/workflows/ path. For example:

jobs:
  my_job:
    uses: stellar/actions/.github/workflows/rust-set-rust-version.yml@main

Actions and Workflows

Rust

General

Name	Type	Description
rust-cache	Action	Caches dependencies, install artifacts, and build artifacts in Rust projects.
disk-cleanup	Action	Frees disk space by removing unnecessary files.
rust-set-rust-version	Workflow	Updates the rust-version in Rust crates to the latest stable version.
[rust-check-git-rev-deps]	Workflow	Check that git rev dependencies do not reference revisions likely to be orphaned.
sdf-ecr-login	Action	Abstraction for SDF's AWS ECR login steps.

Releasing / Publishing

See README-rust-release.md for the release process supported by these workflows.

Name	Type	Description
rust-bump-version	Workflow	Updates the version in Rust crates to a input version.
rust-publish-dry-run	Run a package verification on all crates in a workspace in their published form that automatically figures out the crate dependencies and order to publish (works only for repos without a binary).
rust-publish-dry-run-v2	Run a package verification on all crates in a workspace in their published form that requires an explicit list of crates to publish (works with all repos).
rust-publish	Workflow	Publish all crates in a workspace.

Project Management

Name	Type	Description
update-completed-sprint-on-issue-closed	Workflow	Updates the CompletedSprint project field when an issue/PR is closed.