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

[Docs & CI] Update Release Process Docs and Workflows #5369

Closed
BowTiedDevOps opened this issue Oct 23, 2024 · 7 comments
Closed

[Docs & CI] Update Release Process Docs and Workflows #5369

BowTiedDevOps opened this issue Oct 23, 2024 · 7 comments
Assignees
Labels
CI documentation Requires new or updates to our documentation enhancement Iterations on existing features or infrastructure. locked

Comments

@BowTiedDevOps
Copy link
Collaborator

Since our release process is split into 2 steps (node - 5 point release, signer - 6 point release), and this is what users are familiar with, we'll have to update the documentation and workflow process to reflect this process:

  • Update release-process.md and ci-release.md to reflect the node's 5-point and signer's 6-point release process
  • Add a new signer-specific release workflow that doesn't run all the stacks-core tests, but just signer specific ones.
@BowTiedDevOps BowTiedDevOps added enhancement Iterations on existing features or infrastructure. documentation Requires new or updates to our documentation CI labels Oct 23, 2024
@github-project-automation github-project-automation bot moved this to Status: 🆕 New in Stacks Core Eng Oct 23, 2024
@wileyj
Copy link
Collaborator

wileyj commented Oct 23, 2024

for the signer specific workflow, i'm thinking we can reduce the amount of steps/tests and possibly even simply the build process. what we have today works, but it can be a bit better/faster.

i do have some unconventional ideas i'll share later on too

@hstove
Copy link
Contributor

hstove commented Oct 24, 2024

One suggestion as part of our release process: it would be great if we manually updated the versions in the various Cargo.toml files. When running cargo build without the ENV variable STACKS_NODE_VERSION, the version string generated (ie in /v2/info and in the signer) defaults to the Cargo.toml version. Thus, when people build from source without the ENV variable, the version shows up as 0.1.0 (in the node).

This is mainly important for the two binaries that people run - stacks-signer/Cargo.toml and testnet/stacks-node/Cargo.toml. But we might as well just do a find-and-replace across all of the packages.

@wileyj
Copy link
Collaborator

wileyj commented Oct 24, 2024

related to this issue: #5162

@wileyj
Copy link
Collaborator

wileyj commented Oct 24, 2024

One suggestion as part of our release process: it would be great if we manually updated the versions in the various Cargo.toml files. When running cargo build without the ENV variable STACKS_NODE_VERSION, the version string generated (ie in /v2/info and in the signer) defaults to the Cargo.toml version. Thus, when people build from source without the ENV variable, the version shows up as 0.1.0 (in the node).

This is mainly important for the two binaries that people run - stacks-signer/Cargo.toml and testnet/stacks-node/Cargo.toml. But we might as well just do a find-and-replace across all of the packages.

I like the idea, i'll test this locally to be sure it works as expected for stacks-node as well. for the signer, its not a problem but i'd like to keep the process as similar as possible (meaning we'll want to also update cargo.toml for other workspaces)

@wileyj
Copy link
Collaborator

wileyj commented Oct 25, 2024

Note to self:

./testnet/stacks-node/Cargo.toml # for stacks-node binary
./libsigner/Cargo.toml # for stacks-signer binary
./stackslib/Cargo.toml # for stacks-inspect

create issue for clarity-cli and blockstack-cli to report version to stdout similar to stacks-node/stacks-signer/stacks-inspect

@hstove
Copy link
Contributor

hstove commented Oct 29, 2024

Ah, I didn't realize this was still opened, but I created #5399 to update the "default" versions. Happy to merge it into this. Unfortunately, it doesn't seem like we can use our version format in Cargo.toml, so I went with a different approach.

@wileyj wileyj closed this as completed Nov 14, 2024
@github-project-automation github-project-automation bot moved this from Status: 🆕 New to Status: ✅ Done in Stacks Core Eng Nov 14, 2024
@blockstack-devops
Copy link
Contributor

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@stacks-network stacks-network locked as resolved and limited conversation to collaborators Nov 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CI documentation Requires new or updates to our documentation enhancement Iterations on existing features or infrastructure. locked
Projects
Status: Status: ✅ Done
Development

No branches or pull requests

4 participants