Add ci publish workflow #22
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The way in which ive orchestrated this release cycle is under the assumption: That not every PR into main will result in a crates.io release, but rather every tag in the format of vX.X.X on the main branch will result in a new crates.io/GitHub Release. In its current stage in order to fully implement this Release workflow, The repo repository will need to have an API Secret key for
|
ScottGibb
commented
Nov 8, 2024
ScottGibb
commented
Nov 8, 2024
petekubiak
approved these changes
Nov 8, 2024
alexmoon
reviewed
Nov 8, 2024
alexmoon
approved these changes
Nov 18, 2024
|
@lulf can you add the CARGO_REGISTRY_TOKEN secret to the github settings so this will work? |
|
I actually don't have access to do that for bt-hci, @Dirbaio ^^ |
|
@lulf try now |
|
@alexmoon Done |
gibbz00
pushed a commit
to ergin-org/bt-hci
that referenced
this pull request
Jan 1, 2025
* Added initial workflow for publishing * Adjusted trigger for testing purposes * remove branch for testing * adjusted format of release * Reduced trigger criteria * debugging commit * Debugging the trigger * removing if statement for CI passing * release cycle verified and works * Attempting to trigger it purely on tag based * Added release * workflow debugging * Updated ReadMe and Added Release * Updated dependencies * Debugging * commented out version handler * Putting code back to state for Tagging and Release Management * Updated if statement for checking if CI passed * reset versioning number * Changing order to check for tags first * Latest changes on workflow * adding staging release registry * Added main check * Making the code a bit clearer for publishing to crates.io * Commented back in main registry push * Removed staging registry * Reverting back to old README * Removed formatting change * removed cargo.toml formatting * removed staging registry environment variable
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposal for CI Publishing to crates.io
The following is a very simple solution to ticket #20. It does not involve any changes to the existing CI infrastructure.
How it Works
Whenever a new tag is made in the format VX.X.X, the release workflow will activate. It consists of two jobs.
check: Which is identical to the tests,yml. Ensuring that every release runs our ci testsrelease: This job will only run if the check job passes, It will first verify that the Github tag matches the config.toml tag. Only then will it continue on with the build process and then publish both a GitHub Release and crates.io release. All tags should match each other, allowing a single source of truth to be found.What Other options did I try
Testing
It does sucessfully publish crates to the staging crates.io https://staging.crates.io/crates/ci_playground. It was tested both in CI workflow and on terminal using the--dry-runcommand.