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 description with CHANGELOG and upload an artifact with every build. #397

Merged
merged 1 commit into from
Jul 11, 2024

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 10, 2024

Description

Update release description with CHANGELOG, and upload an artifact with every build.

Before:

Screenshot 2024-07-10 at 3 09 00 PM

After:

https://github.com/dblock/opensearch-api-specification/releases/tag/release-permalink-latest

Screenshot 2024-07-10 at 3 07 41 PM

Also uploads the build artifacts to the workflow run so it can be downloaded with a permalink if needed.

Issues Resolved

Closes #380.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@dblock dblock changed the title Update release description and upload an artifact with every build. Update release description with CHANGELOG and upload an artifact with every build. Jul 10, 2024
Copy link
Contributor

Changes Analysis

Commit SHA: 4e19a1c
Comparing To SHA: 046b7d1

API Changes

Summary

NO CHANGES

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/9880051401/artifacts/1688047199

API Coverage

Before After Δ
Covered (%) 483 (47.31 %) 483 (47.31 %) 0 (0 %)
Uncovered (%) 538 (52.69 %) 538 (52.69 %) 0 (0 %)
Unknown 24 24 0

Copy link
Collaborator

@Xtansia Xtansia left a comment

Choose a reason for hiding this comment

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

I'm happy for this to be merged for now and to just re-visit it later, but I have some opinions:

I'm not super convinced on the value add of the build artifact compared to what's already associated with the release given it's not a true permalink and the only way to map the non-latest commit to an artifact is to query via the actions API.

I also thinks there's an opportunity to clean this workflow up as the automatic gh release action is now unmaintained and editing the release message in multiple steps seems error prone.

@Xtansia Xtansia merged commit 610b6b5 into opensearch-project:main Jul 11, 2024
14 checks passed
@dblock
Copy link
Member Author

dblock commented Jul 11, 2024

I'm not super convinced on the value add of the build artifact compared to what's already associated with the release given it's not a true permalink and the only way to map the non-latest commit to an artifact is to query via the actions API.

True. If nobody uses it we can delete it in the next iteration.

I also thinks there's an opportunity to clean this workflow up as the automatic gh release action is now unmaintained and editing the release message in multiple steps seems error prone.

Yes indeed. Amazingly there's no action that exists that lets you create a release with the description right away. It might actually not be possible? ;)

@dblock dblock deleted the release-permalink branch July 11, 2024 22:09
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.

[FEATURE] Release artifact permalink
2 participants