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

Update release instructions #12

Merged
merged 6 commits into from
Apr 25, 2024
Merged

Update release instructions #12

merged 6 commits into from
Apr 25, 2024

Conversation

bisgardo
Copy link
Contributor

@bisgardo bisgardo commented Mar 22, 2024

Made release instructions clearer and change the "release" tag to happen after the release PR has been merged to main. This (along with the following) ensures that this PR isn't included in the release notes of the next framework release.

Added a workflow to publish a release on tags of the form x.y.z (i.e. for release of the Swift package). This means that we'll have releases both when we publish framework and package (the former now has "(framework)" appended to its release name). This workflow cannot be tested before it's been merged to main, but a workflow_dispatch trigger has been added in case we need to debug.

The old releases have already been updated to conform to the changes in this PR.

The indentation in the workflow files has been adjusted for consistency.

In the "Publish Binary Framework" workflow the zip command was replaced with ditto as that is recommended in various places because it's the command that Finder uses to compress. It apparently also includes things that zip doesn't which could be relevant if the contents were to be signed at some point...

Finally, the generated swift file was also renamed to generated.swift to prevent it from confusing reviewers to think that it's manual work 🙈

Also renamed generated swift file to avoid it being confused for manual work by reviewers.
@bisgardo bisgardo changed the title [WIP] Update release instructions Update release instructions Apr 17, 2024
README.md Outdated Show resolved Hide resolved
@bisgardo bisgardo marked this pull request as ready for review April 24, 2024 21:15
README.md Show resolved Hide resolved
@bisgardo bisgardo merged commit 13dd10c into main Apr 25, 2024
6 checks passed
@bisgardo bisgardo deleted the update-release-instructions branch April 25, 2024 10:23
@bisgardo bisgardo mentioned this pull request Apr 25, 2024
bisgardo added a commit that referenced this pull request Apr 25, 2024
Bump the version of the Cargo project, regenerate Swift bindings, and update the package spec to point to the binary framework built from the updated Cargo project.

This follows the release process described [here](https://github.com/Concordium/concordium-wallet-crypto-swift/blob/13dd10cd4711e9ee77d57a9099d9b37001456afe/README.md#release-new-version).

The `.gitignore` rule for `generated.swift` introduced in #12 had no effect because the file is tracked, so it was removed again. A suggestion to employ a local alternative was added to the doc instead.
@bisgardo bisgardo mentioned this pull request Apr 25, 2024
bisgardo added a commit that referenced this pull request Apr 26, 2024
The workflow (added in #12) erronously uses `github.ref` as the version name, but that value includes a `ref/tags/` prefix that should be removed. Added a step for doing that and ensured that the correct value is used.

Also needed to add submodule checkout for `cargo metadata` to work as well as throwing away logging output on stderr.

It was expected that there could be issues with this workflow becuse it couldn't be tested in advance. It's better tested now, but we still need a full successful run on `main` to be sure.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants