Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify Workflow to Build Signer Releases #4968

Merged
merged 8 commits into from
Jul 22, 2024
Merged

Conversation

BowTiedDevOps
Copy link
Collaborator

Make the required modifications in order to be able to release stacks-node and stacks-signer separately.

Changes:

  • Source Dockerfiles: The CMD instruction now only runs the signer if it is a signer release, otherwise the node.
  • Workflow dispatch input has been removed, the tag is now parsed from the branch name it's being run against.
  • Use composite action that checks if the branch name matches the pattern of a release or not.
  • If it is a release run, build the binaries of the specific release type (only stacks-signer if it is a signer release, otherwise all binaries), then publish the release.
  • Publish to stacks-signer docker repository if it is a signer release, otherwise to default repository (stacks-core in this case) as well as the legacy stacks-blockchain.

How is the release built now?

  • When a release is ready to be created and published, the CI Workflow will have to be run via the workflow_dispatch event against the release branch.

Release branch patterns:

  • release/x.x.x.x.x(-rcx) - A node release branch, where x are numbers, and -rcx is optional.
  • release/signer-x.x.x.x.x.x(-rcx) - A signer release branch, where x are numbers, and -rcx is optional.

Workflow example runs (test failures are unaffected by these changes):

Releases built by this workflow:

Docker images:

Applicable issues:

@BowTiedDevOps BowTiedDevOps self-assigned this Jul 15, 2024
@BowTiedDevOps BowTiedDevOps added enhancement Iterations on existing features or infrastructure. CI labels Jul 15, 2024
@BowTiedDevOps
Copy link
Collaborator Author

The PR was marked as draft because there are still documentation changes in progress.

@saralab saralab requested review from hstove and jferrant July 16, 2024 13:56
@kantai
Copy link
Member

kantai commented Jul 17, 2024

Needs documentation updates for release process in the README

@wileyj
Copy link
Contributor

wileyj commented Jul 17, 2024

my bad - my push yesterday failed because i didn't rebase first.
added the first-pass of signer docs @jferrant @hstove would appreciate if you could let me know if i'm on the right track there.

i think for the stacks-core release docs, i'm going to make as few edits as i can so it's still correct, and address missing/changed items in a different PR so this isn't blocking upcoming deadlines.

@wileyj wileyj marked this pull request as ready for review July 17, 2024 17:53
@wileyj wileyj requested review from a team as code owners July 17, 2024 17:53
@wileyj
Copy link
Contributor

wileyj commented Jul 17, 2024

Needs documentation updates for release process in the README

Bare minimum was updated - it's not entirely correct, but it's close enough to open this for review.

I'll address the larger docs changes in a separate PR.

Copy link
Member

@CharlieC3 CharlieC3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good! Left a few suggestions, but nothing important enough that should be considered blocking.

.github/workflows/image-build-binary.yml Show resolved Hide resolved
.github/workflows/image-build-binary.yml Show resolved Hide resolved
Merged via the queue into develop with commit f160aaf Jul 22, 2024
1 check passed
@wileyj wileyj mentioned this pull request Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI enhancement Iterations on existing features or infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants