Skip to content

Commit

Permalink
chore(all): add changelogs (#1700)
Browse files Browse the repository at this point in the history
## Summary
Provided changelogs.

## Background
Changelogs are good to have.

## Changes
- Added changelogs to all crates for which we have GH releases. Their
release notes were ported into the changelogs.
- Added changelogs to all remaining public-facing crates. Only
`astria-merkle` has been version bumped from 0.1.0, so except for this
one, all of these changelogs are initialised with only an `Unreleased`
section.
- Updated the PR template to remind authors to update relevant
changelogs when opening PRs.
- ~Excluded the changelog files from the markdown linter, since the
format is defined by [Keep a
Changelog](https://keepachangelog.com/en/1.1.0/).~
- Added a markdownlint config file to specify the globs and removed
duplicated globs lists from various places.

## Testing
N/A

## Related Issues
Closes #1687.
  • Loading branch information
Fraser999 authored Oct 25, 2024
1 parent 9ff73ad commit 4f7e53a
Show file tree
Hide file tree
Showing 18 changed files with 1,648 additions and 7 deletions.
8 changes: 7 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,19 @@ Brief background on why these changes were made, ie "why?"
## Testing
How are these changes tested?

## Changelogs
Ensure all relevant changelog files are updated as necessary. See
[keepachangelog](https://keepachangelog.com/en/1.1.0/#how) for change
categories. Replace this text with e.g. "Changelogs updated." or "No updates
required." to acknowledge changelogs have been considered.

## Metrics
- List out metrics added by PR, delete section if none.

## Breaking Changelist
- Bulleted list of breaking changes, any notes on migration. Delete section if none.

## Related Issues
Link any issues that are related, prefer full github links.
Link any issues that are related, prefer full GitHub links.

closes <!-- list any issues closed here -->
4 changes: 0 additions & 4 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,6 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: DavidAnson/markdownlint-cli2-action@v11
with:
globs: |
**/*.md
#.github

charts:
runs-on: ubuntu-latest
Expand Down
10 changes: 10 additions & 0 deletions .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"globs": [
"**/*.md"
],
"ignores": [
"target",
".github",
"**/*/astria-bridge-contracts/lib/**/*.md"
]
}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ npm install markdownlint-cli2 --global
just lint md

# Run with docker
docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.8.1 "**/*.md" "#.github"
docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.8.1
```

## Contributing
Expand Down
14 changes: 14 additions & 0 deletions crates/astria-bridge-contracts/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- markdownlint-disable no-duplicate-heading -->

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

### Added

- Initial release.
95 changes: 95 additions & 0 deletions crates/astria-bridge-withdrawer/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<!-- markdownlint-disable no-duplicate-heading -->

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [1.0.0-rc.2] - 2024-10-23

### Added

- Add `use_compat_address` configuration value [#1671](https://github.com/astriaorg/astria/pull/1671).
- Metric to track total settled funds [#1693](https://github.com/astriaorg/astria/pull/1693).

### Fixed

- Correctly identify rollup return address in ics20 withdrawal actions [#1714](https://github.com/astriaorg/astria/pull/1714).

## [1.0.0-rc.1] - 2024-10-17

### Added

- Add traceability to rollup deposits [#1410](https://github.com/astriaorg/astria/pull/1410).

### Changed

- Pass GRPC and CometBFT clients to consumers directly [#1510](https://github.com/astriaorg/astria/pull/1510).
- Better grpc client construction [#1528](https://github.com/astriaorg/astria/pull/1528).
- Replace `once_cell` with `LazyLock` [#1576](https://github.com/astriaorg/astria/pull/1576).
- Remove action suffix from all action types [#1630](https://github.com/astriaorg/astria/pull/1630).
- Update `futures-util` dependency based on cargo audit warning [#1644](https://github.com/astriaorg/astria/pull/1644).
- Call transactions `Transaction`, contents `TransactionBody` [#1650](https://github.com/astriaorg/astria/pull/1650).
- Rename sequence action to rollup data submission [#1665](https://github.com/astriaorg/astria/pull/1665).
- Upgrade to proto `v1`s throughout [#1672](https://github.com/astriaorg/astria/pull/1672).

### Fixed

- Migrate from `broadcast_tx_commit` to `broadcast_tx_sync` [#1376](https://github.com/astriaorg/astria/pull/1376).
- Fix memo transaction hash encoding [#1428](https://github.com/astriaorg/astria/pull/1428).

## [0.3.0] - 2024-09-06

### Added

- Add instrumentation [#1324](https://github.com/astriaorg/astria/pull/1324).

### Changed

- Enforce withdrawals consumed [#1391](https://github.com/astriaorg/astria/pull/1391).

### Fixed

- Don't fail entire block due to bad withdraw event [#1409](https://github.com/astriaorg/astria/pull/1409).

## [0.2.1] - 2024-08-22

### Changed

- Improve nonce handling [#1292](https://github.com/astriaorg/astria/pull/1292).
- Update `bytemark` dependency based on cargo audit warning [#1350](https://github.com/astriaorg/astria/pull/1350)

## [0.2.0] - 2024-07-26

### Changed

- Move generated contract bindings to crate [#1237](https://github.com/astriaorg/astria/pull/1237).
- Move bridge-unlock memo to core [#1245](https://github.com/astriaorg/astria/pull/1245).
- Refactor startup to a separate subtask and remove balance check from startup [#1190](https://github.com/astriaorg/astria/pull/1190).
- Make bridge unlock memo string [#1244](https://github.com/astriaorg/astria/pull/1244).
- Share code between cli and service [#1270](https://github.com/astriaorg/astria/pull/1270).
- Define bridge memos in proto [#1285](https://github.com/astriaorg/astria/pull/1285).

### Fixed

- Support withdrawer address that differs from bridge address [#1262](https://github.com/astriaorg/astria/pull/1262).
- Disambiguate return addresses [#1266](https://github.com/astriaorg/astria/pull/1266).
- Fix nonce handling [#1215](https://github.com/astriaorg/astria/pull/1215).
- Don't panic on init [#1281](https://github.com/astriaorg/astria/pull/1281).

## 0.1.0 - 2024-06-27

### Added

- Initial release of EVM Withdrawer.

[unreleased]: https://github.com/astriaorg/astria/compare/bridge-withdrawer-v1.0.0-rc.2...HEAD
[1.0.0-rc.2]: https://github.com/astriaorg/astria/compare/bridge-withdrawer-v1.0.0-rc.1...bridge-withdrawer-v1.0.0-rc.2
[1.0.0-rc.1]: https://github.com/astriaorg/astria/compare/bridge-withdrawer-v0.3.0...bridge-withdrawer-v1.0.0-rc.1
[0.3.0]: https://github.com/astriaorg/astria/compare/bridge-withdrawer-v0.2.1...bridge-withdrawer-v0.3.0
[0.2.1]: https://github.com/astriaorg/astria/compare/bridge-withdrawer-v0.2.0...bridge-withdrawer-v0.2.1
[0.2.0]: https://github.com/astriaorg/astria/compare/bridge-withdrawer-v0.1.0...bridge-withdrawer-v0.2.0
104 changes: 104 additions & 0 deletions crates/astria-cli/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
<!-- markdownlint-disable no-duplicate-heading -->

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.5.1] - 2024-10-23

### Added

- Implement frost_ed25519 threshold signing CLI [#1654](https://github.com/astriaorg/astria/pull/1654).
- Add `sign` and `submit` subcommands to `sequencer` CLI [#1696](https://github.com/astriaorg/astria/pull/1696).

### Changed

- Return Bech32m Prefixed Address [#1621](https://github.com/astriaorg/astria/pull/1621).

## [0.5.0] - 2024-10-17

### Added

- Add command to perform ics20 withdrawals [#1631](https://github.com/astriaorg/astria/pull/1631).

### Changed

- Replace `once_cell` with `LazyLock` [#1576](https://github.com/astriaorg/astria/pull/1576).
- Migrate all instances of `#[allow]` to `#[expect]` [#1561](https://github.com/astriaorg/astria/pull/1561).
- Merge argument parsing and command execution [#1568](https://github.com/astriaorg/astria/pull/1568).
- Remove action suffix from all action types [#1630](https://github.com/astriaorg/astria/pull/1630).
- Prefer `astria.primitive.v1.RollupId` over bytes [#1661](https://github.com/astriaorg/astria/pull/1661).
- Call transactions `Transaction`, contents `TransactionBody` [#1650](https://github.com/astriaorg/astria/pull/1650).
- Rename sequence action to rollup data submission [#1665](https://github.com/astriaorg/astria/pull/1665).
- Upgrade to proto `v1`s throughout [#1672](https://github.com/astriaorg/astria/pull/1672).

### Fixed

- Migrate from `broadcast_tx_commit` to `broadcast_tx_sync` [#1376](https://github.com/astriaorg/astria/pull/1376).
- Ensure `checkTx` passes before waiting for inclusion [#1636](https://github.com/astriaorg/astria/pull/1636).

## [0.4.1] - 2024-09-06

### Fixed

- Don't fail entire block due to bad withdraw event [#1409](https://github.com/astriaorg/astria/pull/1409).

## [0.4.0] - 2024-08-28

### Changed

- Update to support dusk-10 as default network [#1418](https://github.com/astriaorg/astria/pull/1418).

## [0.3.1] - 2024-01-23

### Changed

- Bump rpc websocket for dusk-3 [#705](https://github.com/astriaorg/astria/pull/705).

## [0.3.0] - 2024-01-23

### Changed

- Update licenses [#706](https://github.com/astriaorg/astria/pull/706).

### Fixed

- Refactor yaml serialization to match format in rollup's values.yaml [#707](https://github.com/astriaorg/astria/pull/707).

## [0.2.2] - 2024-01-18

### Changed

- Bump for dusk-3 [#689](https://github.com/astriaorg/astria/pull/689).

## [0.2.1] - 2023-12-19

### Changed

- New release with new chart version [#658](https://github.com/astriaorg/astria/pull/658).

## 0.2.0 - 2023-12-11

### Changed

- Update to work with latest rollup charts, and utilize dusk-2 network.

## 0.1.0 - 2023-12-11

### Added

- Dusk 1 CLI release

[unreleased]: https://github.com/astriaorg/astria/compare/cli-v0.5.1...HEAD
[0.5.1]: https://github.com/astriaorg/astria/compare/cli-v0.5.0...cli-v0.5.1
[0.5.0]: https://github.com/astriaorg/astria/compare/cli-v0.4.1...cli-v0.5.0
[0.4.1]: https://github.com/astriaorg/astria/compare/cli-v0.4.0...cli-v0.4.1
[0.3.1]: https://github.com/astriaorg/astria/compare/cli-v0.3.0...cli-v0.3.1
[0.3.0]: https://github.com/astriaorg/astria/compare/cli-v0.2.2...cli-v0.3.0
[0.2.2]: https://github.com/astriaorg/astria/compare/cli-v0.2.1...cli-v0.2.2
[0.2.1]: https://github.com/astriaorg/astria/compare/cli-v0.2.0...cli-v0.2.1
Loading

0 comments on commit 4f7e53a

Please sign in to comment.