Skip to content

Commit

Permalink
working template code
Browse files Browse the repository at this point in the history
  • Loading branch information
biosafetylvl5 committed Oct 15, 2024
1 parent c9a9e44 commit 271aae0
Show file tree
Hide file tree
Showing 3 changed files with 214 additions and 93 deletions.
50 changes: 50 additions & 0 deletions .brassy
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
change_categories:
- bug fix
- enhancement
- deprecation
- removal
- performance
- documentation
- continuous integration
default_description: NO DESCRIPTION
default_title: NO TITLE
default_yaml_path: null
enable_experimental_features: false
templates:
release_template:
- header:
- '{prefix_file}'
- title:
- ''
- Version {release_version} ({release_date})
- '**************************'
- ''
- summary:
- ' * *{change_type}*: {title}'
- entry:
- ''
- '{change_type}'
- ===========
- ''
- '{title}'
- '-------------------------'
- ''
- '{description}'
- ''
- '::'
- ''
- ' {file_change}: {file}'
- footer:
- ''
- '{suffix_file}'
use_color: true
valid_changes:
- deleted
- moved
- added
- modified
valid_fields:
- title
- description
- files
- related-issue
127 changes: 71 additions & 56 deletions sphinx/source/releases/latest.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Version [UNKNOWN] (2024-10-14)
******************************
Version [UNKNOWN] (2024-10-15)
**************************

* *Bug fix*: Print pretty error on blank yaml.
* *Bug fix*: Fix empty "--write-yaml-template bug
Expand All @@ -12,124 +12,139 @@ Version [UNKNOWN] (2024-10-14)
* *Continuous integration*: Add integration tests

Bug fix
=======
===========

Print pretty error on blank yaml.
---------------------------------
-------------------------

Now prints "No valid YAML content in file. Please populate example.yaml" when run on blank yaml file.
Now prints "no valid yaml content in file. please populate example.yaml" when run on blank yaml file.

::

modified: src/brassy/brassy.py
modified: src/brassy/brassy.py

Bug fix
===========

Fix empty "--write-yaml-template bug
------------------------------------
-------------------------

This was previously hotfixed, merging into main codebase now.

::

modified: src/brassy/brassy.py
modified: src/brassy/brassy.py

Bug fix
===========

Fix bug with --write-template-error
-----------------------------------
-------------------------

Fixed issue where --write-template-error wouldnt run without argument

::

modified: src/brassy/brassy.py
modified: src/brassy/brassy.py

Bug fix
===========

Make optional dates optional
----------------------------
-------------------------

Dates for changes are optional. This fix allows users to leave the entry off,
Dates for changes are optional. this fix allows users to leave the entry off,
rather than requiring a null field for building.


::

modified: src/brassy/templates/release_yaml_template.py
modified: src/brassy/templates/release_yaml_template.py

Enhancement
===========

Add internal option to related issue
------------------------------------
-------------------------

Some organizations use internal repos that cannot be accessed by CI. This change adds an "internal" field for the related issue so that users can add strings directly rather than use the URL+issue number combo previously provided. The strings are rendered directly, but must fit a "repo#number - description" pattern. The field is named "internal" to suggest to users that when possible the URL option *should* be used to access future functionality.
Some organizations use internal repos that cannot be accessed by ci. this change adds an "internal" field for the related issue so that users can add strings directly rather than use the url+issue number combo previously provided. the strings are rendered directly, but must fit a "repo#number - description" pattern. the field is named "internal" to suggest to users that when possible the url option *should* be used to access future functionality.

::

modified: src/brassy/templates/release_yaml_template.py
modified: src/brassy/templates/release_yaml_template.py

Enhancement
===========

Add start and finish dates for changes
--------------------------------------
-------------------------

Per user request, start and finish date fields have been added to the yaml template. They are NOT rendered yet.
Per user request, start and finish date fields have been added to the yaml template. they are not rendered yet.

::

modified: src/brassy/brassy.py
modified: src/brassy/brassy.py

Enhancement
===========

Put title at top of template
----------------------------
-------------------------

Title is now at top of template because users were mixing up description and title. This change is backwards compatible, and no updates to yaml files are needed.
Title is now at top of template because users were mixing up description and title. this change is backwards compatible, and no updates to yaml files are needed.

::

modified: src/brassy/brassy.py
modified: src/brassy/brassy.py

Documentation
=============
===========

Fix docs rendering of examples.
-------------------------------
-------------------------

Fix docs rendering of yaml examples by updating old yaml files.

::

modified: docs/api.html
modified: docs/genindex.html
modified: docs/getting-started.html
modified: docs/index.html
modified: docs/objects.inv
modified: docs/searchindex.js
modified: pyproject.toml
modified: sphinx/source/examples/basic-usage/new-release-note
modified: sphinx/source/examples/basic-usage/new-release-note-date
modified: sphinx/source/examples/basic-usage/new-release-note-header-footer
modified: sphinx/source/examples/basic-usage/new-release-note-v1
modified: sphinx/source/examples/basic-usage/release-note.yaml
deleted: docs/py-modindex.html
modified: docs/api.html
modified: docs/genindex.html
modified: docs/getting-started.html
modified: docs/index.html
modified: docs/objects.inv
modified: docs/searchindex.js
modified: pyproject.toml
modified: sphinx/source/examples/basic-usage/new-release-note
modified: sphinx/source/examples/basic-usage/new-release-note-date
modified: sphinx/source/examples/basic-usage/new-release-note-header-footer
modified: sphinx/source/examples/basic-usage/new-release-note-v1
modified: sphinx/source/examples/basic-usage/release-note.yaml
deleted: docs/py-modindex.html

Continuous integration
======================
===========

Add integration tests
---------------------
-------------------------

Added basic integration tests. More work needed.
Added basic integration tests. more work needed.


::

added: pytest.ini
added: tests/inputs/barebones.yaml
added: tests/inputs/fully-featured.yaml
added: tests/inputs/mostly-featured.yaml
added: tests/inputs/to-prune.yaml
added: tests/outputs/barebones.rst
added: tests/outputs/fully-featured.rst
added: tests/outputs/mostly-featured.rst
added: tests/outputs/pruned.yaml
added: tests/test_integ.py
deleted: test/575-cli-class-factory.yaml
deleted: test/burgers.rst
deleted: test/burgers.yaml
deleted: test/test.py
deleted: test/test.rst
deleted: test/test2.yaml
added: pytest.ini
added: tests/inputs/barebones.yaml
added: tests/inputs/fully-featured.yaml
added: tests/inputs/mostly-featured.yaml
added: tests/inputs/to-prune.yaml
added: tests/outputs/barebones.rst
added: tests/outputs/fully-featured.rst
added: tests/outputs/mostly-featured.rst
added: tests/outputs/pruned.yaml
added: tests/test_integ.py
deleted: test/575-cli-class-factory.yaml
deleted: test/burgers.rst
deleted: test/burgers.yaml
deleted: test/test.py
deleted: test/test.rst
deleted: test/test2.yaml
Loading

0 comments on commit 271aae0

Please sign in to comment.