Skip to content

Commit

Permalink
Changelog updates for version 1.3.0 (#128)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fredrikekre
fredrikekre authored Dec 17, 2024
1 parent 0406cb2 commit 33cf8cb
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 2 deletions.
31 changes: 30 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,20 @@ 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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased
## [v1.3.0] - 2024-12-17
### Added
- New executable wrapper script
[`runic`](https://github.com/fredrikekre/Runic.jl/blob/master/bin/runic) that can be put
in `PATH` to simplify Runic invocation. This method should be preferred over a shell
alias since it allows processes other than the shell to invoke Runic. Refer to the
[Installation](https://github.com/fredrikekre/Runic.jl?tab=readme-ov-file#installation)
section of the README for details.
- New Git integration provided by the executable
[`git-runic`](https://github.com/fredrikekre/Runic.jl/blob/master/bin/git-runic) script
([#122]). This can be used to incrementally format a codebase by limiting formatting to
changed and modified lines in each commit. Refer to the [Git
integration](https://github.com/fredrikekre/Runic.jl?tab=readme-ov-file#git-integration)
section of the README for installation and usage instructions.
- New command line argument `--verbose` which enables verbose output ([#121]).
- The library functions `Runic.format_file` and `Runic.format_string` are now considered
part of the Runic public API and are marked with `public` in supported Julia versions.
Expand All @@ -26,6 +38,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
`--lines` can be repeated to specify multiple ranges ([#114], [#120]).

## [v1.1.0] - 2024-12-04
### Added
- Added a suggested README badge to add to your project's README to show that you are using
Runic ([#108], [#112]). See the
[Badge](https://github.com/fredrikekre/Runic.jl?tab=readme-ov-file#badge) section of the
README for details.
- Added a version policy to clarify what formatting changes are allowed in
patch/minor/major releases. See the [Version
policy](https://github.com/fredrikekre/Runic.jl?tab=readme-ov-file#version-policy)
section of the README for details.
### Changed
- Fix a bug that caused "single space after keyword" to not apply after the `function`
keyword in non-standard function definitions ([#113]). This bug is classified as a
Expand Down Expand Up @@ -81,12 +102,20 @@ First stable release of Runic.jl. See [README.md](README.md) for details and doc
[v1.0.1]: https://github.com/fredrikekre/Runic.jl/releases/tag/v1.0.1
[v1.1.0]: https://github.com/fredrikekre/Runic.jl/releases/tag/v1.1.0
[v1.2.0]: https://github.com/fredrikekre/Runic.jl/releases/tag/v1.2.0
[v1.3.0]: https://github.com/fredrikekre/Runic.jl/releases/tag/v1.3.0
[#97]: https://github.com/fredrikekre/Runic.jl/issues/97
[#108]: https://github.com/fredrikekre/Runic.jl/issues/108
[#109]: https://github.com/fredrikekre/Runic.jl/issues/109
[#110]: https://github.com/fredrikekre/Runic.jl/issues/110
[#112]: https://github.com/fredrikekre/Runic.jl/issues/112
[#113]: https://github.com/fredrikekre/Runic.jl/issues/113
[#114]: https://github.com/fredrikekre/Runic.jl/issues/114
[#116]: https://github.com/fredrikekre/Runic.jl/issues/116
[#117]: https://github.com/fredrikekre/Runic.jl/issues/117
[#118]: https://github.com/fredrikekre/Runic.jl/issues/118
[#120]: https://github.com/fredrikekre/Runic.jl/issues/120
[#121]: https://github.com/fredrikekre/Runic.jl/issues/121
[#122]: https://github.com/fredrikekre/Runic.jl/issues/122
[#123]: https://github.com/fredrikekre/Runic.jl/issues/123
[#124]: https://github.com/fredrikekre/Runic.jl/issues/124
[#127]: https://github.com/fredrikekre/Runic.jl/issues/127
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "Runic"
uuid = "62bfec6d-59d7-401d-8490-b29ee721c001"
version = "1.2.0"
version = "1.3.0"

[deps]
JuliaSyntax = "70703baa-626e-46a2-a12c-08ffd08c73b4"
Expand Down

2 comments on commit 33cf8cb

@fredrikekre
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/121555

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.3.0 -m "<description of version>" 33cf8cbf45c61dc8949cfe874c74c7c76546a73e
git push origin v1.3.0

Please sign in to comment.