Skip to content

Commit

Permalink
docs: add CHANGELOG.md (#127)
Browse files Browse the repository at this point in the history
* chore: remove old file

* docs: start CHANGELOG.md

* ci: add reminder to update CHANGELOG.md

* docs(changelog): add link to PR
  • Loading branch information
Pitasi authored Mar 26, 2024
1 parent e26f599 commit 733eb1b
Show file tree
Hide file tree
Showing 3 changed files with 112 additions and 94 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/changelog-reminder.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Checks if a changelog is missing in the PR diff
name: Changelog Reminder
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
paths: ["**/*.go", "**/*.ts", "**/*.tsx"]
permissions:
pull-requests: write
jobs:
remind:
name: Changelog Reminder
runs-on: ubuntu-latest
# Skip draft PRs and PRs starting with: revert, test, chore, ci, docs, style, build, refactor
if: "!github.event.pull_request.draft && !contains(github.event.pull_request.title, 'revert') && !contains(github.event.pull_request.title, 'test') && !contains(github.event.pull_request.title, 'chore') && !contains(github.event.pull_request.title, 'ci') && !contains(github.event.pull_request.title, 'docs') && !contains(github.event.pull_request.title, 'style') && !contains(github.event.pull_request.title, 'build') && !contains(github.event.pull_request.title, 'refactor')"
steps:
- uses: actions/checkout@v4
- uses: mskelton/changelog-reminder-action@v3
with:
message: |
Hey @${{ github.actor }} and thank you for opening this pull request! 👋🏼
It looks like you forgot to add a changelog entry for your changes. Make sure to add a changelog entry in the 'CHANGELOG.md' file.
89 changes: 89 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<!--
Guiding Principles:
Changelogs are for humans, not machines.
There should be an entry for every single version.
The same types of changes should be grouped.
Versions and sections should be linkable.
The latest version comes first.
The release date of each version is displayed.
Mention whether you follow Semantic Versioning.
Usage:
Change log entries are to be added to the Unreleased section under the
appropriate stanza (see below). Each entry is required to include a tag and
the GitHub issue reference in the following format:
* (<tag>) \#<issue-number> message
The tag should consist of where the change is being made ex. (x/staking), (store)
The issue numbers will later be link-ified during the release process so you do
not have to worry about including a link manually, but you can if you wish.
Types of changes (Stanzas):
"Features" for new features.
"Improvements" for changes in existing functionality.
"Bug Fixes" for any bug fixes.
"API Breaking" for breaking exported APIs used by developers building on SDK.
"Consensus Breaking CHANGES" for any changes that result in a different AppState given same genesisState and txList.
Ref: https://keepachangelog.com/en/1.1.0/
-->

# 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]

### Consensus Breaking Changes

### Features

### Bug Fixes

### Misc

* (docs) [#127](https://github.com/warden-protocol/wardenprotocol/pull/127) Add CHANGELOG.md


## [v0.2.0](https://github.com/warden-protocol/wardenprotocol/releases/tag/v0.2.0) - 2024-03-26

### Consensus Breaking Changes

* (x/warden) [#77](https://github.com/warden-protocol/wardenprotocol/pull/77) Use uint64 IDs for Space and Keychain, instead of string bech32 addresses
* (x/intent) [#55](https://github.com/warden-protocol/wardenprotocol/pull/55) Initial release of the `shield` intent engine, replacing the old `boolparser` and cleaning up the API
* (x/intent) [#112](https://github.com/warden-protocol/wardenprotocol/pull/112) Store a list of referenced addresses when a new intent is created. This is useful for querying all intents that reference a given address.
* Refactor of `x/intent`'s and `x/warden`'s store design to improve queries performance:
* (x/intent) [#117](https://github.com/warden-protocol/wardenprotocol/pull/117) Pin the intent definition when an Action is created instead of just referencing it. This allows faster queries "by address" by storing the list of addresses directly inside the action, instead of having to re-evaluate the linked intent for each action.
* (x/warden) [#121](https://github.com/warden-protocol/wardenprotocol/pull/121) Separate Keys queries into `AllKeys`, `KeysBySpaceId`, and `KeyById`. This allowed some improvements, especially in the `KeysBySpaceId` that can benefit from a new "space id -> key id" index.
* (x/warden) [#122](https://github.com/warden-protocol/wardenprotocol/pull/122) Improve `SpacesByOwner` query by adding a new "owner -> space id" index.

### Features

* (client) [#116](https://github.com/warden-protocol/wardenprotocol/pull/116) Add `warden q wait-tx` command to wait for a transaction to be included in a block
* The same command was submitted to Cosmos SDK: https://github.com/cosmos/cosmos-sdk/pull/19870
* (clichain) [#113](https://github.com/warden-protocol/wardenprotocol/pull/113) Initial release of `clichain`, a CLI for acting as a Keychain from the command line
* (x/warden) [#109](https://github.com/warden-protocol/wardenprotocol/pull/109) Add ability to assign an intent to a key, overriding the SignIntent of the Space
* [#110](https://github.com/warden-protocol/wardenprotocol/pull/110) Add MsgUpdateKey for updating a key's intent
* (keychain-sdk) [#92](https://github.com/warden-protocol/wardenprotocol/pull/92) Increase Keychain SDK's throughput by batching requests into a single transaction
* (snap) [#83](https://github.com/warden-protocol/wardenprotocol/pull/83) Initial release of Warden Protocol's MetaMask snap
* (build) [#69](https://github.com/warden-protocol/wardenprotocol/pull/69) Add Makefile for building `wardend`
* (faucet) [#99](https://github.com/warden-protocol/wardenprotocol/pull/99) Rate limit faucet requests by IP address, not only by account
* (faucet) [#66](https://github.com/warden-protocol/wardenprotocol/pull/66) Batch multiple faucet request in a single transaction

### Bug Fixes

* (x/warden) [#120](https://github.com/warden-protocol/wardenprotocol/pull/120) Don't stop Keys query if one key is invalid (i.e. fails to derive a layer 1 address)


## [v0.1.0](https://github.com/warden-protocol/wardenprotocol/releases/tag/v0.1.0) - 2024-03-06

Initial release of `wardend` and launch of the Alfama testnet.


94 changes: 0 additions & 94 deletions spaceward/CHANGELOG.md

This file was deleted.

0 comments on commit 733eb1b

Please sign in to comment.