Brassy

What's Changed

Please [read the docs](https://biosafetylvl5.github.io/brassy/using-brassy.html) to learn about new features!

Some features are `experimental` and must be turned on in your settings.

New and of-note in this release:
- Config files; run `brassy --init` to generate one
- Ability to write templates with a pipe (`|`) for the description by default (only when experimental settings are enabled)
- Ability to use a "default directory" where template yaml files will be added by default (only when experimental settings are enabled)
- Date fields for issues
- Better errors
- Support for internal repos
- Lots of bug fixes 🫠

* Fix docs yaml by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/3
* Readable error when brassy runs on blank file by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/4
* Fix template arg error by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/5
* Add rich tracebacks by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/10
* Put title above description in template by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/12
* Add date field by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/15
* Start on config file opener, validator and format by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/11
* Default-template updates for new config options by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/23
* Add prune option for yaml files by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/24
* Make the description field a pipe by default by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/26
* Refactor brassy layout, validate yaml files with pydantic add messages class by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/27
* Add integration tests by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/28
* Accept strings in related issue for compatibility with internal repos with inaccessible urls by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/31
* Add workflow by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/32
* Add experimental setting, make yaml_dir auto-finding experimental by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/33
* Release note template by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/34
* Add config option for no fail on empty dir by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/36
* Add pypi version badge by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/37
* Fix builds not having content if title or description not defined by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/38
* Prepare for 0.0.3 release (many changes) by biosafetylvl5 in https://github.com/biosafetylvl5/brassy/pull/40

**Full Changelog**: https://github.com/biosafetylvl5/brassy/compare/v0.0.2...v0.0.3

See [the docs](https://biosafetylvl5.github.io/brassy/releases/0.0.3.html) for more user friendly update logs.

* Enhancement: Added --output-to-console
* Enhancement: Enable building without writing to file
* Enhancement: Add --get-changed-files
* Bug fix: Empty file change lines removed from output
* Bug fix: Fixed quiet not being quiet.

Enhancements
===========

Added --output-to-console
-------------------------

--output-to-console now writes generated release notes to the console.
This is disabled by default.

modified: src/brassy/brassy.py

Enable building without writing to file
---------------------------------------

Previously, if no output file was specified, brassy quit with an "Invalid Arguments"
error. Now brassy will build the release notes and print a message saying no
file was written because no output file was passed. This is helpful for verifying
the build process works without having to write to a temporary file.

modified: src/brassy/brassy.py

Add --get-changed-files
-----------------------

Running brassy with --get-changed-files now outputs the files that have been
modified, added, deleted or moved in the current branch as compared to the main
branch. It runs on the current directory by default,
but it accepts a path as an argument.

For example, the output looks like this:


brassy --get-changed-files

added: test
modified: test2
deleted: test3
moved: test4

It prints with indents for easy copy-and-pasting into your yaml files.

modified: src/brassy/brassy.py

Bug fixes
=======

Empty file change lines removed from output
-------------------------------------------

In the files section, if (eg.) "modified:" was left blank,
a blank "modified:" would be generated in resulting release notes.
Those stray blank entries are now removed from the output.

modified: src/brassy/brassy.py

Fixed quiet not being quiet.
----------------------------

When running with --quiet, non-error output would be outputted. Fixed.

modified: src/brassy/brassy.py