Temporarily return thecontext.history variable to release notes generation as many users are using it in their release documentation. It was never intended to be provided and will be removed in the future.

Context was removed inv9.8.3 during a refactor and condensing of changelog and release notes functionality. Ends up the context was provided accidentally because of variable re-use rather than explicit definition which is why it broke upon refactor.

How did you test?

Performed some manual testing with a custom template upon the PSR repository. See the commands below for replication. The importance is that the release notes was printed to the console using--noop mode so we are sure that the formatting and use was working.

How to Verify

Add the following file to PSR repository:

{# file: templates/.release_notes.md.j2 #}{%setreleases =context.history.released.items() |list%}{%setprev_version_tag =releases[1][0].as_tag()%}{%setnew_version_tag =version.as_tag()%}{%setversion_compare_url =prev_version_tag |compare_url(new_version_tag)%}{%setdetailed_changes_link ='[{}...{}]({})'.format(prev_version_tag,new_version_tag,version_compare_url)%}---**Detailed Changes**: {{ detailed_changes_link }}

Executesemantic-release --noop changelog --post-to-release-tag v9.8.6

codejedi365 added2 commits

August 18, 2024 15:04

fix(release-notes): providecontext.history global in release note …

89032b4

…templatesTemporarily return the `context.history` variable to release notes generationas many users are using it in their release documentation. It was never intendedto be provided and will be removed in the future.context was removed in `v9.8.3` during a refactor and condensing of changelogand release notes functionality.Resolves:python-semantic-release#984

fix(release-notes): fix noop-changelog to print raw release notes

c226c51

Some markdown sequences can be interpreted as ansi escape sequences which dilutedebugging of release note templates by the user. This change ensures the rawcontent is displayed to the console as expected.

codejedi365 self-assigned this

Aug 20, 2024

codejedi365 merged commit5bd91b4 intopython-semantic-release:master

Aug 20, 2024

codejedi365 deleted the fix/missing-context-in-release-notes branch

August 20, 2024 04:30

maxrake mentioned this pull request

Aug 21, 2024

jinja2.exceptions.UndefinedError: 'context' is undefined#984

Closed

maxrake added a commit to phylum-dev/phylum-ci that referenced this pull request

Aug 21, 2024

build: updatepython-semantic-release pin

94a0b0e

This change is an update to the one made in#454. Since then, the`python-semantic-release` (PSR) dependency has responded to theirbreaking change by re-defining the `context` variable for release notestemplates. However, they also say that the variable was not meant tobe exposed in the first place and that it will be removed again in thenext major version release. Therefore, the pin has been changed to acaret-style one to allow for getting future releases that are at leastv9.8.7 but less than v10.Discussions with the maintainer are ongoing, to request the featuresrelied upon with the current implementation are accounted for in thenext major version release.References:*python-semantic-release/python-semantic-release#1005*python-semantic-release/python-semantic-release#984Additionally, the release notes template was refactored a tiny bit toaccount for new methods of doing the same thing, but with less code. Thechanges were tested locally and found to produce the same output as theprevious template.

maxrake mentioned this pull request

Aug 21, 2024

build: updatepython-semantic-release pinphylum-dev/phylum-ci#463

Merged

maxrake added a commit to phylum-dev/phylum-ci that referenced this pull request

Aug 21, 2024

build: updatepython-semantic-releasepin (#463)

1c14f1a

This change is an update to the one made in#454. Since then, the`python-semantic-release` (PSR) dependency has responded to theirbreaking change by re-defining the `context` variable for release notestemplates. However, they also say that the variable was not meant to beexposed in the first place and that it will be removed again in the nextmajor version release. Therefore, the pin has been changed to acaret-style one to allow for getting future releases that are at leastv9.8.7 but less than v10.Discussions with the maintainer are ongoing, to request the featuresrelied upon with the current implementation are accounted for in thenext major version release.References:*python-semantic-release/python-semantic-release#1005*python-semantic-release/python-semantic-release#984Additionally, the release notes template was refactored a tiny bit toaccount for new methods of doing the same thing, but with less code. Thechanges were tested locally and found to produce the same output as theprevious template.