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

chore: enable release-please & add it to CI #1155

Merged
merged 6 commits into from
Feb 9, 2023
Merged

Conversation

weboko
Copy link
Collaborator

@weboko weboko commented Feb 8, 2023

Problem

Right now it takes some time to make a release of @waku/* packages and it is mostly manual work that blocks other devs.

Solution

Considering different approaches release-please is the most convenient one.

Example of an automated PR for next release: #1157

Notes

Default mapping is used:
https://git.io/JqCZL
Description of config:
https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md

@weboko weboko requested a review from fryorcraken as a code owner February 8, 2023 01:26
@@ -0,0 +1,11 @@
{
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is needed as starting point to create next versions. Description

@@ -0,0 +1,18 @@
{
"bootstrap-sha": "13183350fac680be8c0e89ca3dc3951330b8b7c0",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I intentionally defined properties with default valued because they might be used by someone later.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

btw it is a hash of a commit (not including) from which it will make next release

@github-actions
Copy link

github-actions bot commented Feb 8, 2023

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
Waku core 133.54 KB (0%) 2.7 s (0%) 3.6 s (+0.64% 🔺) 6.2 s
Waku default setup 423.93 KB (0%) 8.5 s (0%) 8.9 s (+51.06% 🔺) 17.4 s
ECIES encryption 44.86 KB (0%) 898 ms (0%) 3.3 s (+31.95% 🔺) 4.2 s
Symmetric encryption 44.86 KB (0%) 898 ms (0%) 2.5 s (+15.87% 🔺) 3.3 s
DNS discovery 108.63 KB (0%) 2.2 s (0%) 3.7 s (+0.85% 🔺) 5.9 s
Privacy preserving protocols 132.54 KB (0%) 2.7 s (0%) 2.3 s (-40.06% 🔽) 4.9 s
Light protocols 134.55 KB (0%) 2.7 s (0%) 3.8 s (+52.83% 🔺) 6.5 s
History retrieval protocols 134.38 KB (0%) 2.7 s (0%) 2.9 s (-5.24% 🔽) 5.6 s

Copy link
Collaborator

@fryorcraken fryorcraken left a comment

Choose a reason for hiding this comment

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

another concern I have is around changelog management.

Copy link
Collaborator

@fryorcraken fryorcraken left a comment

Choose a reason for hiding this comment

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

@weboko. I guess this does not handle changelog at all, what are you thoughts on managing changelog?

@weboko
Copy link
Collaborator Author

weboko commented Feb 9, 2023

@fryorcraken changelog is automatically updated based on commits.
Here is an example of release PR - #1157

@fryorcraken
Copy link
Collaborator

@weboko last remaining question: are we able to do patch increment only?

@weboko
Copy link
Collaborator Author

weboko commented Feb 9, 2023

Right now it should be patch only.
Example - weboko/test-release...release-please--branches--weboko/test-release

@weboko weboko requested a review from fryorcraken February 9, 2023 10:04
@fryorcraken
Copy link
Collaborator

@weboko does it mean it releases for any change? or it only release for feat/fix ?

@weboko @danisharora099 I propose to make PR approval mandatory from this PR because it now directly release. Today we only patch increment but once we do minor and patch increment, we'll need a second pair of eye to ensure that we mark PR as breaking API when they do. Nothing worse than a lib with a patch bump that breaks backward compatibility. WDYT?

@weboko
Copy link
Collaborator Author

weboko commented Feb 9, 2023

@weboko does it mean it releases for any change? or it only release for feat/fix ?

@weboko @danisharora099 I propose to make PR approval mandatory from this PR because it now directly release. Today we only patch increment but once we do minor and patch increment, we'll need a second pair of eye to ensure that we mark PR as breaking API when they do. Nothing worse than a lib with a patch bump that breaks backward compatibility. WDYT?

I agree, but in case a mistake will be made - we still can fix it in a release PR created by the bot.

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.

ci: automated release process
2 participants