ci: Refactor scripts #60
Conversation
febo
force-pushed
the
febo/refactor-ci
branch
from
c2ad80e to
6be0456
Compare
febo
force-pushed
the
febo/refactor-ci
branch
from
8bb36fb to
20e4cfb
Compare
febo
force-pushed
the
febo/refactor-ci
branch
from
20e4cfb to
4f7ad78
Compare
|
Just realised that the "filter" is not as precise as it should be. For example, when the main Update: The conditional filter was removed. |
Cargo.toml
Outdated
| @@ -17,5 +17,14 @@ repository = "https://github.com/anza-xyz/pinocchio" | |||
|
|
|||
| [workspace.dependencies] | |||
| five8_const = "0.1.3" | |||
| pinocchio = { path = "sdk/pinocchio", version = ">= 0.6, <= 0.7" } | |||
| pinocchio-pubkey = { path = "sdk/pubkey", version = "0.2.1" } | |||
| pinocchio = { path = "sdk/pinocchio", version = ">= 0.6" } | |||
There was a problem hiding this comment.
Why is the version specified like that?
There was a problem hiding this comment.
This is probably me not using the workspace dependencies correctly. I was trying to avoid bumping dependencies on other packages unnecessarily. For example, if pinocchio-pubkey can work with multiple versions of pinocchio and pinocchio has been bumped to 0.7, I still want to specify that pinocchio-pubkey works with anything from >= 0.6.
But perhaps this is not the correct way to do that.
There was a problem hiding this comment.
Ah I see, let's just keep them all at the same version for now, I think it'll make things simpler in the long run.
Cargo.toml
Outdated
| @@ -17,5 +17,14 @@ repository = "https://github.com/anza-xyz/pinocchio" | |||
|
|
|||
| [workspace.dependencies] | |||
| five8_const = "0.1.3" | |||
| pinocchio = { path = "sdk/pinocchio", version = ">= 0.6, <= 0.7" } | |||
| pinocchio-pubkey = { path = "sdk/pubkey", version = "0.2.1" } | |||
| pinocchio = { path = "sdk/pinocchio", version = ">= 0.6" } | |||
There was a problem hiding this comment.
Ah I see, let's just keep them all at the same version for now, I think it'll make things simpler in the long run.
Problem
CI currently has limited checks and the
publish.ymlworkflow is limited to a couple of crates.Solution
Refactor the CI. This involved using a new set of supporting scripts, which can also be used from the command-line:
audit: audit dependencies of the workspacebuild: build a crate withbuild-sbf(useful to detect issues with code under thetarget = solanaconfigurationclippy: run clippydoc: linting of doc sectionsformat: runcargo fmthack: linting of feature powersetlint: executeclippy && doc && hackin sequencesemver: semantic versioning validationtest: runcargo testCI make use of these scripts to run:
auditformatclippydochackbuildtestThe
publish.ymlworkflow was updated to work with any crate of the reposiroty and incorporatessemver-checksbased on the version level. If the version level selected for publishing violates semantic versioning, the publishing fails. For example, if the code to be published under apatchversion contains breaking changes, thesemver-checkwill fail and the publish workflow will abort.Note
The code in main is currently failing the
doclinting - #64 fixes these issues.