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

Add release workflow #35

Merged
merged 1 commit into from
Nov 11, 2022
Merged

Conversation

Joffref
Copy link
Contributor

@Joffref Joffref commented Oct 15, 2022

Signed-off-by: Mathis Joffre [email protected]

Issue #, if available: #6 and #13

Description of changes: Add automatic publish of a binary release on tag creation that follows pattern : v*

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@Joffref Joffref requested a review from a team as a code owner October 15, 2022 18:27
.github/workflows/release.yaml Outdated Show resolved Hide resolved
.github/workflows/release.yaml Show resolved Hide resolved
Copy link
Contributor

@austinvazquez austinvazquez left a comment

Choose a reason for hiding this comment

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

Thanks @Joffref. LGTM.

.github/workflows/release.yaml Show resolved Hide resolved

- name: Release
uses: softprops/action-gh-release@v1
with:
Copy link
Contributor

Choose a reason for hiding this comment

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

We're going to want release notes to go into the releases page. For firecracker-go-sdk, we have a CHANGELOG.md where we keep a running list of changes with a header for the version number. Maybe we could do the same here and parse out the set of changes to go in the release notes? (I think something simple like find the line that starts with # ${RELEASE_VERSION} and copy every line after that until the next line that starts with #.

That might be fine for a follow up PR, though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Knowing that there is at the moment no release file, I think it's more convenient to add this step to the workflow later in another PR to make it testable. What is your feeling about this ?

Choose a reason for hiding this comment

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

We have that available and use it widely across all OpenFaaS projects and some of my own:

Have a look if the format is suitable for you? https://github.com/alexellis/arkade/releases

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that could be reduced to just the changes that would be visible to someone consuming the binary, but yes, something like that would work.

Let's defer that discussion for now. I think we can get one release out first and then worry about how to structure future release notes.

Choose a reason for hiding this comment

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

SGTM @Kern-- - when do you expect to merge and release a binary?

We can then wind down https://github.com/alexellis/tc-tap-redirect-builder

Copy link
Contributor

Choose a reason for hiding this comment

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

I'll merge this now. We have a little more process to follow than just pushing a tag today, so I'll get it going now to get this out ASAP.

.github/workflows/release.yaml Show resolved Hide resolved
Signed-off-by: Mathis Joffre <[email protected]>
@Kern-- Kern-- merged commit b589b55 into awslabs:master Nov 11, 2022
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.

4 participants