Improve `changelog` template #1028

arboleya · 2023-05-30T10:24:36Z

A few notes:

The version is mentioned only once, at the top
Changes are grouped by patch|minor|major
Empty groups can be hidden (like major, in the example below)
For each commit, there's a list of the packages affected by it

Release - 0.43.1

Patch:

Support EVM Address type, by @danielbate (See #995)
- @fuel-ts/address
- @fuel-ts/interfaces
- @fuel-ts/abi-coder
Another Patch Message.. @arboleya (See #NNN)
- @fuel-ts/abc
- @fuel-ts/xyz

Minor:

Something else.. @Dhaiwat10 (See #NNN)
- @fuel-ts/xyz

Breaking Changes:

Something else.. @Dhaiwat10 (See #NNN)
- @fuel-ts/xyz

Here we'd repeat only the breaking ones.

Originally posted by @arboleya in #1022 (comment)

Dhaiwat10 · 2023-06-01T18:45:44Z

I'll take care of this along with #970

arboleya · 2023-12-11T11:16:02Z

Write manual release notes for important releases #1347

arboleya · 2024-02-05T16:23:50Z

We really need to devise a solution to these noisy changelogs.

arboleya · 2024-02-05T16:24:00Z

Craft a solution for a 'centralized' changelog for the fuels package #970

nedsalk · 2024-03-12T06:51:50Z

Here's a bit of a different take but in the same spirit of reducing noise:

There are no groupings by patch|minor|major because the title of the changelog already contains what type of update it is (RELEASE - 0.77.0 is a minor update),
All the affected packages of the release are listed once under the title for completion's sake,
Changes are grouped into breaking and non-breaking and each change is shown only once,
Changes are sub-grouped into features, fixes, refactors, chores, and docs,
Breaking changes are formatted the same way as non-breaking changes,
The affected packages are put into a one-liner instead of a bullet point list (looks less cluttered)

Also note that I didn't format the changes as bullet points. That is because the changeset's description can have bullet points themselves, be multiline, etc. All of its formatting would be affected by a bullet point dash before it.

RELEASE - 0.77.0

fuels, @fuel-ts/abi-coder, @fuel-ts/account, @fuel-ts/address, @fuel-ts/contract, @fuel-ts/crypto, @fuel-ts/errors, @fuel-ts/hasher, @fuel-ts/merkle, @fuel-ts/transactions

Breaking Changes

Yay, no breaking changes!

Non-breaking Changes

Features

Added requestMiddleware to ProviderOptions as a way to allow the user the modification of each fetch call's request, by @nedsalk (see #1822)
(packages: @fuel-ts/account)

Fixes

Handling SqueezedOut status update when calling submitAndAwait subscription at Provider.sendTransaction
Handling SqueezedOut status update when calling statusChange subscrition at TransactionResponse.waitForResult, by @Torres-ssf (see fix: handling SqueezedOut status update on GraphQL subscriptions #1829)
(packages: @fuel-ts/account, @fuel-ts/errors)

fix: disallow transferring <= 0 amounts, by @Dhaiwat10 (see #1827)
(packages: @fuel-ts/account, @fuel-ts/errors)

Chores

Migrate implementations of sha256, keccak and scrypt to @noble/hashes, by @danielbate (see #1786)
(packages: @fuel-ts/abi-coder, @fuel-ts/account, @fuel-ts/address, @fuel-ts/contract, @fuel-ts/crypto, @fuel-ts/errors, @fuel-ts/hasher, @fuel-ts/merkle, @fuel-ts/transactions)

Add try/catch block when parsing GraphQL stream data response, by @Torres-ssf (see #1839)
(packages: @fuel-ts/account, @fuel-ts/errors)

arboleya · 2024-03-15T13:56:28Z

I liked the new grouping. 👌

But let's try to reduce noise even more.

A few assumptions:

PR titles should be short and sweet
Changesets must follow the PR title (and nothing else 👈 )
PR Descriptions may contain, in this order:
1. The issue it is closing
2. Breaking change notes
3. Summary, notes, details, etc.

See:

PR example below, inspired by #1826
Changelog example in the next comment

Close Move predicate data setting into constructor #1506

Breaking

// old API
const predicate = new Predicate(bytecode, provider, abi, configurableConstants);

// new API
const predicate = new Predicate({
  bytecode,
  abi, // optional
  provider,
  inputData, // optional
  configurableConstants, // optional
});

Summary

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

arboleya · 2024-03-15T13:56:57Z

Release - 0.43.1

Breaking

Features
- #1356 Add launchTestNode utility, by @nedsalk
- #1826 Improve Predicate DX; accepting data in the constructor, by @Dhaiwat10
Fixes
- #1787 Assemble of Transfer operation, by @Torres-ssf
Chores
- #1877 Exporting Asset types, by @Torres

Features

#995 Support EvmAddress, by @danielbate
#1864 Add local faucet for the create-fuels app, by @Dhaiwat10
#1864 Added new Date wrapper, by @petertonysmith94

Fixes

#1847 Handling empty changesets in release4 workflow, by @nedsalk

petertonysmith94 · 2024-03-15T14:21:21Z

#1028 (comment)

This decreases the noise massively and better summarises the release into a small digest.

Is it worth adding all the affected packages for the release as a whole? Like @nedsalk had here.

Release - 0.43.1

fuels, @fuel-ts/abi-coder, @fuel-ts/account, @fuel-ts/address, @fuel-ts/contract, @fuel-ts/crypto, @fuel-ts/errors, @fuel-ts/hasher, @fuel-ts/merkle, @fuel-ts/transactions
...
...

Torres-ssf · 2024-03-15T14:31:57Z

Release - 0.43.1

Breaking

Features:

#1356 Add launchTestNode utility, by @nedsalk

#1826 Improve Predicate DX; accepting data in the constructor,
...

I really liked this proposed version. It's very clean and easy to read

arboleya · 2024-03-15T14:39:26Z

@petertonysmith94 I don't think we should list the affected packages in the release notes.

We bump all packages together on each release anyway; it's like everything changed.

However, each package will still have its changelog file.

petertonysmith94 · 2024-03-15T15:03:53Z

@arboleya All very valid points. I retract my previous suggestion.

nedsalk · 2024-03-15T16:42:29Z

We can differentiate between breaking and non-breaking changes with $\color{red}{\bf{(!)}}$, put the breaking changes first and simplify it further:

Release - 0.43.1

Features

#1826 Improve Predicate DX; accepting data in the constructor, by @Dhaiwat10 $\color{red}{\bf{(!)}}$
#995 Support EvmAddress, by @danielbate $\color{red}{\bf{(!)}}$
#1864 Add local faucet for the create-fuels app, by @Dhaiwat10
#1864 Added new Date wrapper, by @petertonysmith94

Fixes

#1787 Assemble of Transfer operation, by @Torres-ssf $\color{red}{\bf{(!)}}$
#1847 Handling empty changesets in release4 workflow, by @nedsalk

Chores

#1877 Exporting Asset types, by @Torres

arboleya · 2024-03-15T16:53:41Z

I see value in grouping all breaks and using a text version; it appears more neutral.

The red icons also look somewhat off to me.

nedsalk · 2024-03-15T17:17:05Z

I see value in grouping all breaks

You're right. I'll be implementing your version in the PR.

Dhaiwat10 self-assigned this Jun 1, 2023

arboleya added settings chore Issue is a chore labels Dec 7, 2023

Torres-ssf removed the settings label Dec 8, 2023

Dhaiwat10 removed their assignment Dec 11, 2023

arboleya mentioned this issue Dec 11, 2023

Write manual release notes for important releases #1347

Closed

arboleya mentioned this issue Jan 5, 2024

feat: replace elliptic with @noble/curves #1601

Merged

arboleya added the priority label Feb 9, 2024

arboleya changed the title ~~Shrink custom changelog template even more~~ Improve changelog template Feb 9, 2024

nedsalk self-assigned this Mar 10, 2024

nedsalk mentioned this issue Mar 13, 2024

feat: improve changelog template #1872

Merged

nedsalk mentioned this issue Mar 19, 2024

fix: command fuels version not working #1883

Merged

nedsalk closed this as completed in #1872 Mar 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve `changelog` template #1028

Improve `changelog` template #1028

arboleya commented May 30, 2023 •

edited

Loading

Dhaiwat10 commented Jun 1, 2023

arboleya commented Dec 11, 2023

arboleya commented Feb 5, 2024

arboleya commented Feb 5, 2024

nedsalk commented Mar 12, 2024 •

edited

Loading

arboleya commented Mar 15, 2024 •

edited

Loading

arboleya commented Mar 15, 2024 •

edited

Loading

petertonysmith94 commented Mar 15, 2024 •

edited

Loading

Release - 0.43.1

Torres-ssf commented Mar 15, 2024 •

edited

Loading

Release - 0.43.1

Breaking

arboleya commented Mar 15, 2024

petertonysmith94 commented Mar 15, 2024

nedsalk commented Mar 15, 2024 •

edited

Loading

arboleya commented Mar 15, 2024

nedsalk commented Mar 15, 2024

Improve changelog template #1028

Improve changelog template #1028

Comments

arboleya commented May 30, 2023 • edited Loading

Release - 0.43.1

Patch:

Minor:

Breaking Changes:

Dhaiwat10 commented Jun 1, 2023

arboleya commented Dec 11, 2023

arboleya commented Feb 5, 2024

arboleya commented Feb 5, 2024

nedsalk commented Mar 12, 2024 • edited Loading

RELEASE - 0.77.0

Breaking Changes

Non-breaking Changes

Features

Fixes

Chores

arboleya commented Mar 15, 2024 • edited Loading

Breaking

Summary

arboleya commented Mar 15, 2024 • edited Loading

Release - 0.43.1

Breaking

Features

Fixes

petertonysmith94 commented Mar 15, 2024 • edited Loading

Release - 0.43.1

Torres-ssf commented Mar 15, 2024 • edited Loading

Release - 0.43.1

Breaking

arboleya commented Mar 15, 2024

petertonysmith94 commented Mar 15, 2024

nedsalk commented Mar 15, 2024 • edited Loading

Release - 0.43.1

Features

Fixes

Chores

arboleya commented Mar 15, 2024

nedsalk commented Mar 15, 2024

Improve `changelog` template #1028

Improve `changelog` template #1028

arboleya commented May 30, 2023 •

edited

Loading

nedsalk commented Mar 12, 2024 •

edited

Loading

arboleya commented Mar 15, 2024 •

edited

Loading

arboleya commented Mar 15, 2024 •

edited

Loading

petertonysmith94 commented Mar 15, 2024 •

edited

Loading

Torres-ssf commented Mar 15, 2024 •

edited

Loading

nedsalk commented Mar 15, 2024 •

edited

Loading