Skip to content

Commit

Permalink
doc: improve cliff config, regenerate CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
@crazyscot
crazyscot committed Jul 6, 2024
1 parent 06665ae commit 5eb1deb
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 146 deletions.
198 changes: 57 additions & 141 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Changelog

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

(N.B. This file is autogenerated from the git commit logs.)

## [1.0.0] - 2024-07-06

Expand Down Expand Up @@ -44,6 +46,7 @@ All notable changes to this project will be documented in this file.

- Add an exemplar render
- Set up git-cliff, autogenerate changelog to date ([#120](https://github.com/crazyscot/brot3/issues/120))
- Improve cliff config, regenerate CHANGELOG


### <!-- 4 -->⚡ Performance
Expand All @@ -56,6 +59,7 @@ All notable changes to this project will be documented in this file.

- Update icon
- Better fonts; rework HUD; consolidate menus
- Change MaxIter accelerator to avoid clashing with Cmd-M on OSX ([#131](https://github.com/crazyscot/brot3/issues/131))


### <!-- 7 -->⚙️ Miscellaneous Tasks
Expand All @@ -66,186 +70,98 @@ All notable changes to this project will be documented in this file.
- Silence chunk size warning
- Yarn upgrade
- Cargo update clap strum_macros tauri
- Tweak github release template
- Tweak dependabot config (commit messages)


### Cargo

- *(deps)* Bump the cargo group with 4 updates

### Build

### Npm

- *(deps)* Bump the npm group in /ui with 4 updates
- Fix OSX license path ([#130](https://github.com/crazyscot/brot3/issues/130))


## [0.9.4] - 2024-06-05

### Cargo

- *(deps)* Bump the cargo group with 2 updates
- *(deps)* Bump the cargo group with 3 updates


### Cli

- Add option to print the info string


### Engine

- Introduce float_format utilities
- Update plot info strings to output with the same precision rules as the HUD


### Npm

- *(deps-dev)* Bump vite from 5.2.11 to 5.2.12 in /ui in the npm group


### Ui

- Apply precision bounds in HUD, format floats more consistently


## [0.9.2] - 2024-03-21

### Menu.rs
### <!-- 0 -->🚀 Features

- Wrap functions into a struct
- *(cli)* Add option to print the info string
- *(engine)* Introduce float_format utilities
- *(engine)* Update plot info strings to output with the same precision rules as the HUD
- *(ui)* Apply precision bounds in HUD, format floats more consistently


### Rust
### <!-- 1 -->🐛 Bug Fixes

- Add get_metadata, add ts twins
- Fix menu accelerators on macos


## [0.9.1-unreleased] - 2024-03-08

### <!-- 7 -->⚙️ Miscellaneous Tasks

- On macos, build universal binary


### Cli

- Add missing help text, --help aliases


### Render_rgba

- Remove a middleman variable


## [0.9.0-unreleased] - 2024-02-29

### Tidyup

- Move type definitions to their own source

- Fix (or possibly perpetrate?) build argument madness on OSX ([#80](https://github.com/crazyscot/brot3/issues/80))
- Update rust version for CVE ([#86](https://github.com/crazyscot/brot3/issues/86))
- Viewer: make fields private ([#95](https://github.com/crazyscot/brot3/issues/95))

### Tilespec

- Tidy up accessors, add top_left & bottom_right quasi-accessors
## [0.9.3] - 2024-04-01

### <!-- 0 -->🚀 Features

### Viewertilespec

- Fields should be u64, add Display trait


## [0.1.0] - 2024-02-03

### Renderer

- Refactor render to be render-to-file, taking filename & colourer.


### Tile

- :new now takes PlotData
- :join()


### Bugfix

- Origin is bottom-left; output the top row first
- Refactor data reversal in y axis


### Cli

- Move styling out to a module
- Split and rejoin the tile (still single threaded for now)
- Print the info string
- Split out file extension autodetector


### Cli/plot

- Tests


### Colourer

- Refactor max_iters as u32, for consistency


### Colouring

- :framework needn't be a pub mod
- Move all types into 'types'
- Move Rgb8, OutputsHsvf from types into framework
- (what's left of) types.rs -> testing.rs
- Use from_color_unclamped


### Filename

- Get a Path properly
- Write_handle gives a buffered handle
- Add open_for_writing helper

- *(ui)* Go To Point ([#73](https://github.com/crazyscot/brot3/issues/73))
- *(ui)* Add centre to position display
- *(ui)* Add close X controls to HUD and position entry form
- *(ui)* Remove menu checkmark on Go To Position
- *(ui)* Add Copy Current Position button
- *(ui)* Rearrange HUD/goto form
- *(ui)* Add GenericError alerter
- Implement Save Image
- Allow user to specify the size to save at

### Fractal

- Move framework out to its own source file, for consistency
- Move maths types out to their own source
### <!-- 1 -->🐛 Bug Fixes

- Defer initial position display

### Get_test_tile_spec

- Now takes a dimension argument
### <!-- 2 -->🚜 Refactor

- Split updateIndicator for readability
- Move HUD and position entry forms into viewer.ts
- HUD selects element of the info panel, not whole document
- Rename variables & fields for consistency
- Rename go_to -> go_to_position for clarity; remove needless extra functions
- Move DOM utility classes out to separate file
- Move HUD class, HTML and functionality out to separate file
- Rename FractalMetadata => FractalView (rust & TS)
- Introduce the helper type UserDestination
- Have the menu builder clone and hack tauri os_default for now
- Promote autodetect_extension to render::framework
- Move GenericError to a new Util module
- Rename dom_util.tr_is_visible

### Listable

- Add list2() for now
### <!-- 7 -->⚙️ Miscellaneous Tasks

- Code formatting TS,CSS ([#76](https://github.com/crazyscot/brot3/issues/76))
- Ci fixes
- Rework TileSpec::Display to be filename-friendly

### Png

- Refactor render into two
- Make -o- work
## [0.9.2] - 2024-03-21

### <!-- 1 -->🐛 Bug Fixes

### Pointdata
- Fix indent (no functional change)

- Refactor to use ndarray, which has mutable slice accessors
- Fix bogus viewport dimensions on startup (after resize)


### Render

- :factory: reorder ctor arguments for consistency
- Move framework to its own file, for consistency
- Tidy up derives
- Use enum_delegate instead of enum_dispatch
- Replace EnumIter with a longer-winded String pathway
### <!-- 2 -->🚜 Refactor

- Refactor toggle_zoom as a detail of a new display_message event

### Tilespec
- Refactor showAbout into the new display_message event

- Store width & height as a tuple
- Use non-square test data for split tests


<!-- generated by git-cliff -->
21 changes: 16 additions & 5 deletions cliff.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
# changelog header
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
Notable changes to this project will be documented in this file.\n
(N.B. This file is autogenerated from the git commit logs.)\n
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
Expand Down Expand Up @@ -57,33 +58,43 @@ postprocessors = [
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
filter_unconventional = false
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
# Replace issue numbers
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},

# Check spelling of the commit with https://github.com/crate-ci/typos
# If the spelling is incorrect, it will be automatically fixed.
#{ pattern = '.*', replace_command = 'typos --write-changes -' },

# Refactor legacy quasi-conventional commit messages
{ pattern = '\[(ui|engine|cli)\]', replace = 'feat(${1}):' },
{ pattern = '(cli|engine|ui):', replace = 'feat(${1}):' },
{ pattern = '\[bugfix\]', replace = 'fix:' },
{ pattern = '\[(chore|ci|feature|misc|refactor)\]', replace = '${1}:' },
]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^fix|^bugfix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore\\(release\\): update version", skip = true },
{ message = "^chore\\(deps.*\\)", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "^chore\\(pull\\)", skip = true },
{ message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
{ message = "^chore|^ci|^misc|^tidyup", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },
{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },
{ message = "^cargo|^npm\\((deps|deps-dev)\\)|^internal|^menu.rs|^rust|^bump", skip = true },
#{ message = "^.*:", group = "Other" }, # not useful
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
Expand All @@ -92,7 +103,7 @@ filter_commits = false
# regex for matching git tags
tag_pattern = "v[0-9].*"
# regex for skipping tags
# skip_tags = ""
skip_tags = "unreleased|0.1.0"
# regex for ignoring tags
# ignore_tags = ""
# sort the tags topologically
Expand Down

0 comments on commit 5eb1deb

Please sign in to comment.