Consider using release branches #1124

jbesraa · 2024-08-21T08:51:00Z

and maintain only main without dev branch.

relates to #1098

github-actions · 2024-08-21T08:59:32Z

Bencher

Report	Wed, August 28, 2024 at 07:57:58 UTC
Project	Stratum v2 (SRI)
Branch	1124/merge
Testbed	sv1

Click to view all benchmark results

Benchmark	Latency	Latency Results nanoseconds (ns) \| (Δ%)	Latency Upper Boundary nanoseconds (ns) \| (%)
client-submit-serialize	✅ (view plot)	6,462.60 (-6.10%)	7,352.15 (87.90%)
client-submit-serialize-deserialize	✅ (view plot)	7,488.70 (-4.08%)	8,330.11 (89.90%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle	✅ (view plot)	8,131.60 (-2.97%)	8,834.10 (92.05%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle	✅ (view plot)	896.07 (-0.45%)	928.91 (96.46%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize	✅ (view plot)	704.43 (+0.97%)	717.09 (98.23%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize	✅ (view plot)	251.72 (+1.16%)	257.04 (97.93%)
client-sv1-get-authorize/client-sv1-get-authorize	✅ (view plot)	158.11 (+0.48%)	163.16 (96.91%)
client-sv1-get-submit	✅ (view plot)	6,350.60 (-4.56%)	7,128.10 (89.09%)
client-sv1-get-subscribe/client-sv1-get-subscribe	✅ (view plot)	286.89 (+2.83%)	290.89 (98.63%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle	✅ (view plot)	752.74 (+0.38%)	780.02 (96.50%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize	✅ (view plot)	616.96 (+0.51%)	635.35 (97.11%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize	✅ (view plot)	206.24 (-0.24%)	218.98 (94.18%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

github-actions · 2024-08-21T08:59:33Z

Bencher

Report	Wed, August 28, 2024 at 07:57:58 UTC
Project	Stratum v2 (SRI)
Branch	2024-08-20-release
Testbed	sv1

🚨 1 ALERT: Threshold Boundary Limit exceeded!

Benchmark	Measure (units)	View	Value	Lower Boundary	Upper Boundary
serialize_deserialize_handle_subscribe	RAM Accesses (accesses)	🚨 (view plot \| view alert)	390.00 (+1.01%)		389.90 (100.03%)

Click to view all benchmark results

Benchmark	Estimated Cycles	Estimated Cycles Results estimated cycles \| (Δ%)	Estimated Cycles Upper Boundary estimated cycles \| (%)	Instructions	Instructions Results instructions \| (Δ%)	Instructions Upper Boundary instructions \| (%)	L1 Accesses	L1 Accesses Results accesses \| (Δ%)	L1 Accesses Upper Boundary accesses \| (%)	L2 Accesses	L2 Accesses Results accesses \| (Δ%)	L2 Accesses Upper Boundary accesses \| (%)	RAM Accesses	RAM Accesses Results accesses \| (Δ%)	RAM Accesses Upper Boundary accesses \| (%)
get_authorize	✅ (view plot)	8,541.00 (+1.18%)	8,744.55 (97.67%)	✅ (view plot)	3,772.00 (+0.77%)	3,862.57 (97.66%)	✅ (view plot)	5,296.00 (+0.87%)	5,413.39 (97.83%)	✅ (view plot)	5.00 (-32.79%)	10.66 (46.89%)	✅ (view plot)	92.00 (+2.10%)	94.35 (97.51%)
get_submit	✅ (view plot)	95,718.00 (+0.16%)	96,159.48 (99.54%)	✅ (view plot)	59,522.00 (+0.08%)	59,768.77 (99.59%)	✅ (view plot)	85,498.00 (+0.09%)	85,827.37 (99.62%)	✅ (view plot)	49.00 (-9.59%)	62.48 (78.43%)	✅ (view plot)	285.00 (+0.99%)	288.94 (98.63%)
get_subscribe	✅ (view plot)	8,102.00 (+1.44%)	8,302.30 (97.59%)	✅ (view plot)	2,848.00 (+0.65%)	2,944.63 (96.72%)	✅ (view plot)	3,982.00 (+0.70%)	4,106.92 (96.96%)	✅ (view plot)	12.00 (-22.66%)	20.34 (58.98%)	✅ (view plot)	116.00 (+2.65%)	117.95 (98.35%)
serialize_authorize	✅ (view plot)	12,392.00 (+1.36%)	12,558.78 (98.67%)	✅ (view plot)	5,343.00 (+0.55%)	5,433.57 (98.33%)	✅ (view plot)	7,457.00 (+0.60%)	7,575.97 (98.43%)	✅ (view plot)	7.00 (-31.15%)	13.95 (50.18%)	✅ (view plot)	140.00 (+2.88%)	141.73 (98.78%)
serialize_deserialize_authorize	✅ (view plot)	24,670.00 (+0.73%)	24,767.03 (99.61%)	✅ (view plot)	9,950.00 (+0.44%)	10,037.46 (99.13%)	✅ (view plot)	14,050.00 (+0.51%)	14,170.35 (99.15%)	✅ (view plot)	31.00 (-13.45%)	42.07 (73.68%)	✅ (view plot)	299.00 (+1.26%)	299.18 (99.94%)
serialize_deserialize_handle_authorize	✅ (view plot)	30,270.00 (+0.39%)	30,388.37 (99.61%)	✅ (view plot)	12,127.00 (+0.24%)	12,217.57 (99.26%)	✅ (view plot)	17,165.00 (+0.25%)	17,289.77 (99.28%)	✅ (view plot)	59.00 (+0.52%)	64.21 (91.89%)	✅ (view plot)	366.00 (+0.58%)	367.54 (99.58%)
serialize_deserialize_handle_submit	✅ (view plot)	126,605.00 (+0.14%)	127,067.17 (99.64%)	✅ (view plot)	73,307.00 (+0.07%)	73,610.86 (99.59%)	✅ (view plot)	105,095.00 (+0.09%)	105,505.15 (99.61%)	✅ (view plot)	109.00 (-7.96%)	132.10 (82.51%)	✅ (view plot)	599.00 (+0.65%)	601.19 (99.64%)
serialize_deserialize_handle_subscribe	✅ (view plot)	27,614.00 (+0.55%)	27,668.86 (99.80%)	✅ (view plot)	9,650.00 (+0.19%)	9,746.63 (99.01%)	✅ (view plot)	13,649.00 (+0.19%)	13,781.53 (99.04%)	✅ (view plot)	63.00 (-3.77%)	73.07 (86.22%)	🚨 (view plot \| view alert)	390.00 (+1.01%)	389.90 (100.03%)
serialize_deserialize_submit	✅ (view plot)	115,367.00 (+0.21%)	115,712.96 (99.70%)	✅ (view plot)	68,167.00 (+0.13%)	68,407.06 (99.65%)	✅ (view plot)	97,842.00 (+0.16%)	98,169.12 (99.67%)	✅ (view plot)	61.00 (-10.57%)	76.73 (79.50%)	✅ (view plot)	492.00 (+0.72%)	494.33 (99.53%)
serialize_deserialize_subscribe	✅ (view plot)	23,088.00 (+0.82%)	23,185.35 (99.58%)	✅ (view plot)	8,209.00 (+0.27%)	8,303.19 (98.87%)	✅ (view plot)	11,563.00 (+0.28%)	11,690.50 (98.91%)	✅ (view plot)	37.00 (-5.35%)	43.72 (84.64%)	✅ (view plot)	324.00 (+1.50%)	324.04 (99.99%)
serialize_submit	✅ (view plot)	100,125.00 (+0.20%)	100,512.18 (99.61%)	✅ (view plot)	61,566.00 (+0.07%)	61,817.44 (99.59%)	✅ (view plot)	88,345.00 (+0.09%)	88,680.32 (99.62%)	✅ (view plot)	46.00 (-15.34%)	63.91 (71.97%)	✅ (view plot)	330.00 (+1.46%)	332.00 (99.40%)
serialize_subscribe	✅ (view plot)	11,541.00 (+1.66%)	11,681.75 (98.80%)	✅ (view plot)	4,195.00 (+0.44%)	4,291.63 (97.75%)	✅ (view plot)	5,836.00 (+0.42%)	5,964.95 (97.84%)	✅ (view plot)	14.00 (-12.33%)	19.23 (72.79%)	✅ (view plot)	161.00 (+3.19%)	162.15 (99.29%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

github-actions · 2024-08-21T08:59:46Z

Bencher

Report	Wed, August 28, 2024 at 07:58:01 UTC
Project	Stratum v2 (SRI)
Branch	2024-08-20-release
Testbed	sv2

Click to view all benchmark results

Benchmark	Latency	Latency Results nanoseconds (ns) \| (Δ%)	Latency Upper Boundary nanoseconds (ns) \| (%)
client_sv2_handle_message_common	✅ (view plot)	44.02 (-1.26%)	45.44 (96.87%)
client_sv2_handle_message_mining	✅ (view plot)	74.85 (+1.95%)	81.51 (91.83%)
client_sv2_mining_message_submit_standard	✅ (view plot)	14.64 (-0.08%)	14.69 (99.63%)
client_sv2_mining_message_submit_standard_serialize	✅ (view plot)	275.96 (+3.87%)	285.27 (96.74%)
client_sv2_mining_message_submit_standard_serialize_deserialize	✅ (view plot)	581.26 (-1.98%)	624.61 (93.06%)
client_sv2_open_channel	✅ (view plot)	167.93 (+1.49%)	171.25 (98.06%)
client_sv2_open_channel_serialize	✅ (view plot)	279.53 (-1.15%)	293.26 (95.32%)
client_sv2_open_channel_serialize_deserialize	✅ (view plot)	379.34 (+0.11%)	424.10 (89.45%)
client_sv2_setup_connection	✅ (view plot)	159.49 (-2.64%)	174.35 (91.48%)
client_sv2_setup_connection_serialize	✅ (view plot)	458.49 (-3.16%)	505.64 (90.68%)
client_sv2_setup_connection_serialize_deserialize	✅ (view plot)	978.54 (+0.64%)	1,041.58 (93.95%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

github-actions · 2024-08-21T08:59:49Z

Bencher

Report	Wed, August 28, 2024 at 07:57:56 UTC
Project	Stratum v2 (SRI)
Branch	2024-08-20-release
Testbed	sv2

Click to view all benchmark results

Benchmark	Estimated Cycles	Estimated Cycles Results estimated cycles \| (Δ%)	Estimated Cycles Upper Boundary estimated cycles \| (%)	Instructions	Instructions Results instructions \| (Δ%)	Instructions Upper Boundary instructions \| (%)	L1 Accesses	L1 Accesses Results accesses \| (Δ%)	L1 Accesses Upper Boundary accesses \| (%)	L2 Accesses	L2 Accesses Results accesses \| (Δ%)	L2 Accesses Upper Boundary accesses \| (%)	RAM Accesses	RAM Accesses Results accesses \| (Δ%)	RAM Accesses Upper Boundary accesses \| (%)
client_sv2_handle_message_common	✅ (view plot)	2,153.00 (+4.23%)	2,170.45 (99.20%)	✅ (view plot)	473.00 (+0.40%)	485.45 (97.44%)	✅ (view plot)	728.00 (-0.50%)	752.86 (96.70%)	✅ (view plot)	12.00 (+56.00%)	12.92 (92.89%)	✅ (view plot)	39.00 (+5.36%)	39.52 (98.68%)
client_sv2_handle_message_mining	✅ (view plot)	8,251.00 (+0.56%)	8,338.32 (98.95%)	✅ (view plot)	2,143.00 (+0.61%)	2,171.82 (98.67%)	✅ (view plot)	3,166.00 (+0.56%)	3,215.47 (98.46%)	✅ (view plot)	37.00 (-3.10%)	43.03 (85.98%)	✅ (view plot)	140.00 (+0.70%)	141.99 (98.60%)
client_sv2_mining_message_submit_standard	✅ (view plot)	6,378.00 (+1.40%)	6,417.90 (99.38%)	✅ (view plot)	1,756.00 (+0.31%)	1,764.03 (99.55%)	✅ (view plot)	2,553.00 (-0.03%)	2,573.99 (99.18%)	✅ (view plot)	23.00 (+25.84%)	24.45 (94.08%)	✅ (view plot)	106.00 (+1.79%)	107.36 (98.73%)
client_sv2_mining_message_submit_standard_serialize	✅ (view plot)	14,877.00 (+0.58%)	15,033.48 (98.96%)	✅ (view plot)	4,700.00 (+0.11%)	4,708.03 (99.83%)	✅ (view plot)	6,757.00 (+0.03%)	6,774.18 (99.75%)	✅ (view plot)	49.00 (+3.31%)	51.75 (94.69%)	✅ (view plot)	225.00 (+0.97%)	229.82 (97.90%)
client_sv2_mining_message_submit_standard_serialize_deserialize	✅ (view plot)	27,659.00 (+0.55%)	27,862.68 (99.27%)	✅ (view plot)	10,591.00 (+0.39%)	10,591.75 (99.99%)	✅ (view plot)	15,404.00 (+0.35%)	15,405.06 (99.99%)	✅ (view plot)	85.00 (+1.28%)	89.11 (95.38%)	✅ (view plot)	338.00 (+0.79%)	345.06 (97.96%)
client_sv2_open_channel	✅ (view plot)	4,395.00 (-1.83%)	4,617.13 (95.19%)	✅ (view plot)	1,461.00 (+0.05%)	1,473.29 (99.17%)	✅ (view plot)	2,155.00 (+0.09%)	2,171.55 (99.24%)	✅ (view plot)	14.00 (+13.61%)	15.63 (89.54%)	✅ (view plot)	62.00 (-4.07%)	68.58 (90.40%)
client_sv2_open_channel_serialize	✅ (view plot)	14,114.00 (-0.63%)	14,439.20 (97.75%)	✅ (view plot)	5,064.00 (+0.01%)	5,076.29 (99.76%)	✅ (view plot)	7,324.00 (+0.07%)	7,338.90 (99.80%)	✅ (view plot)	35.00 (-4.97%)	41.05 (85.26%)	✅ (view plot)	189.00 (-1.28%)	198.21 (95.35%)
client_sv2_open_channel_serialize_deserialize	✅ (view plot)	22,731.00 (+0.33%)	23,008.74 (98.79%)	✅ (view plot)	8,027.00 (+0.46%)	8,028.70 (99.98%)	✅ (view plot)	11,666.00 (+0.38%)	11,669.56 (99.97%)	✅ (view plot)	85.00 (+13.17%)	86.83 (97.89%)	✅ (view plot)	304.00 (-0.17%)	313.98 (96.82%)
client_sv2_setup_connection	✅ (view plot)	4,723.00 (+0.44%)	4,768.39 (99.05%)	✅ (view plot)	1,502.00 (+0.05%)	1,514.29 (99.19%)	✅ (view plot)	2,273.00 (-0.15%)	2,297.32 (98.94%)	✅ (view plot)	14.00 (+42.86%)	15.34 (91.25%)	✅ (view plot)	68.00 (+0.14%)	69.62 (97.67%)
client_sv2_setup_connection_serialize	✅ (view plot)	16,214.00 (-0.31%)	16,465.91 (98.47%)	✅ (view plot)	5,963.00 (+0.01%)	5,975.29 (99.79%)	✅ (view plot)	8,654.00 (-0.01%)	8,675.11 (99.76%)	✅ (view plot)	49.00 (+7.97%)	50.66 (96.73%)	✅ (view plot)	209.00 (-0.91%)	216.75 (96.42%)
client_sv2_setup_connection_serialize_deserialize	✅ (view plot)	35,622.00 (+0.20%)	35,749.37 (99.64%)	✅ (view plot)	14,855.00 (+0.25%)	14,856.58 (99.99%)	✅ (view plot)	21,812.00 (+0.24%)	21,813.90 (99.99%)	✅ (view plot)	102.00 (+2.00%)	111.90 (91.15%)	✅ (view plot)	380.00 (+0.08%)	384.04 (98.95%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

plebhash · 2024-08-21T13:11:12Z

RELEASE.md

+- Constrain each development cycle to a fixed time period, after which a release
+  is made. Typically, the development cycle is 6-8 weeks long.


@pavlenex @GitGab19 what are your thoughts about having a time constrain on release cycles?

I think that if we release ONLY on 6/8 weeks we will find ourself rushing to get PR merged nearby the release. That of course will impact the quality of the code. For example if we have a feature that we need and is almost ready and release is in 3 days we will do everything possible to have it in the next release otherwise we will have to wait 8 weeks.

I think that we should aim to a more precise time frame for future releases (even if it's generally hard in a FOSS environment), and 6 to 8 weeks looks reasonable to me. If we will encounter some barriers as the one mentioned by @Fi3 I'm pretty sure we could postpone the specific release a little bit. At the end we will keep asserting the progress on every dev call as usual. As a general guideline, I would leave it

IMHO having shorter release cycle solve better this issue

I'm not too opinionated on this, but is seems a reasonable middle ground between the arguments presented so far would be to:

aim for 4/6 weeks (shorter cycle)

if some specific task is taking longer than expected, we postpone it to the next release (so that we're not rushing anything)

what do you guys think?

I would wait for @pavlenex input, he's definitely the one with more experience regarding time frames and roadmap definition in FOSS 😉

if some specific task is taking longer than expected, we postpone it to the next release (so that we're not rushing anything)

yep this is ideal and should be always like that but there is a positive correlation between the length of release cycle and the willinges to ignore best practice and rushing thing to not miss the release.

it seems @pavlenex won't be available to provide his input

for now, let's avoid blocking this PR because of this

let's just remove this phrase about release timeline

it seems @pavlenex won't be available to provide his input

for now, let's avoid blocking this PR because of this

let's just remove this phrase about release timeline

Agree 👍

RELEASE.md

Fi3 · 2024-08-21T15:11:14Z

concept ack

RELEASE.md

jbesraa · 2024-08-26T08:31:40Z

@GitGab19 @plebhash what do you think about adding a CHANGELOG.md file in addition to the gh release notes, that should be updated on each release with the following:

General release information
Breaking changes(if any)
Notable changes

GitGab19 · 2024-08-26T10:42:43Z

@GitGab19 @plebhash what do you think about adding a CHANGELOG.md file in addition to the gh release notes, that should be updated on each release with the following:
* General release information

* Breaking changes(if any)

* Notable changes

Yes. I think it can definitely add value 👍

plebhash · 2024-08-26T12:54:36Z

@GitGab19 @plebhash what do you think about adding a CHANGELOG.md file in addition to the gh release notes, that should be updated on each release with the following:

General release information

Breaking changes(if any)

Notable changes

sounds like a good idea!

RELEASE.md

Use release branches on every new release, creating branch/tag for every release. This change also eliminates the `dev` branch and suggest to only maintain `main` branch.

jbesraa force-pushed the 2024-08-20-release branch 2 times, most recently from 0f49f57 to 2d1899c Compare August 21, 2024 08:59

jbesraa marked this pull request as ready for review August 21, 2024 09:02

jbesraa changed the title ~~Consider using release branches..~~ Consider using release branches Aug 21, 2024

plebhash mentioned this pull request Aug 21, 2024

Optimise contributing and release processes #1098

Closed

1 task

rrybarczyk linked an issue Aug 21, 2024 that may be closed by this pull request

Optimise contributing and release processes #1098

Closed

1 task

plebhash reviewed Aug 21, 2024

View reviewed changes

rrybarczyk reviewed Aug 21, 2024

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

plebhash reviewed Aug 21, 2024

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

rrybarczyk reviewed Aug 21, 2024

View reviewed changes

RELEASE.md Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

jbesraa force-pushed the 2024-08-20-release branch 2 times, most recently from dd337a2 to ce13eb9 Compare August 23, 2024 11:49

This was referenced Aug 23, 2024

merge CONTRIBUTING and README-DEV files into a single file #1139

Closed

merge CONTRIBUTING.md + README-DEV.md #1140

Merged

new conventions for v1.1.0 #1141

Closed

plebhash reviewed Aug 23, 2024

View reviewed changes

RELEASE.md Show resolved Hide resolved

plebhash mentioned this pull request Aug 23, 2024

publish libs to crates.io on release tags #1142

Merged

jbesraa force-pushed the 2024-08-20-release branch from ce13eb9 to fb2b32b Compare August 26, 2024 08:28

jbesraa force-pushed the 2024-08-20-release branch from fb2b32b to ecd3e4d Compare August 26, 2024 13:06

jbesraa commented Aug 26, 2024

View reviewed changes

RELEASE.md Show resolved Hide resolved

plebhash reviewed Aug 26, 2024

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

Use release branches

4e34e3d

Use release branches on every new release, creating branch/tag for every release. This change also eliminates the `dev` branch and suggest to only maintain `main` branch.

jbesraa force-pushed the 2024-08-20-release branch from ecd3e4d to 4e34e3d Compare August 28, 2024 07:53

GitGab19 approved these changes Aug 28, 2024

View reviewed changes

plebhash approved these changes Aug 28, 2024

View reviewed changes

plebhash changed the base branch from dev to main August 28, 2024 12:03

plebhash merged commit 5f3c49e into stratum-mining:main Aug 28, 2024
33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consider using release branches #1124

Consider using release branches #1124

jbesraa commented Aug 21, 2024

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

plebhash Aug 21, 2024

Fi3 Aug 21, 2024

GitGab19 Aug 21, 2024

Fi3 Aug 21, 2024

plebhash Aug 21, 2024 •

edited

Loading

GitGab19 Aug 21, 2024

Fi3 Aug 22, 2024

plebhash Aug 27, 2024

GitGab19 Aug 27, 2024

Fi3 commented Aug 21, 2024

jbesraa commented Aug 26, 2024

GitGab19 commented Aug 26, 2024

plebhash commented Aug 26, 2024

		- Constrain each development cycle to a fixed time period, after which a release
		is made. Typically, the development cycle is 6-8 weeks long.

Consider using release branches #1124

Consider using release branches #1124

Conversation

jbesraa commented Aug 21, 2024

github-actions bot commented Aug 21, 2024 • edited Loading

Bencher

github-actions bot commented Aug 21, 2024 • edited Loading

Bencher

github-actions bot commented Aug 21, 2024 • edited Loading

Bencher

github-actions bot commented Aug 21, 2024 • edited Loading

Bencher

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

plebhash Aug 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fi3 commented Aug 21, 2024

jbesraa commented Aug 26, 2024

GitGab19 commented Aug 26, 2024

plebhash commented Aug 26, 2024

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

plebhash Aug 21, 2024 •

edited

Loading