Replace 'removal' by 'breaking' changelog category
As discussed, sometimes we will need to introduce changes which are not necessarily removals but might break existing suites
This commit is contained in:
		
							parent
							
								
									3a0f436c1a
								
							
						
					
					
						commit
						c6ed69a666
					
				| 
						 | 
				
			
			@ -53,8 +53,8 @@ repos:
 | 
			
		|||
    -   id: changelogs-rst
 | 
			
		||||
        name: changelog filenames
 | 
			
		||||
        language: fail
 | 
			
		||||
        entry: 'changelog files must be named ####.(feature|bugfix|doc|deprecation|removal|vendor|trivial).rst'
 | 
			
		||||
        exclude: changelog/(\d+\.(feature|improvement|bugfix|doc|deprecation|removal|vendor|trivial).rst|README.rst|_template.rst)
 | 
			
		||||
        entry: 'changelog files must be named ####.(breaking|bugfix|deprecation|doc|feature|improvement|trivial|vendor).rst'
 | 
			
		||||
        exclude: changelog/(\d+\.(breaking|bugfix|deprecation|doc|feature|improvement|trivial|vendor).rst|README.rst|_template.rst)
 | 
			
		||||
        files: ^changelog/
 | 
			
		||||
    -   id: py-deprecated
 | 
			
		||||
        name: py library is deprecated
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -18,7 +18,7 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
 | 
			
		|||
* ``bugfix``: fixes a reported bug.
 | 
			
		||||
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
 | 
			
		||||
* ``deprecation``: feature deprecation.
 | 
			
		||||
* ``removal``: feature removal.
 | 
			
		||||
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
 | 
			
		||||
* ``vendor``: changes in packages vendored in pytest.
 | 
			
		||||
* ``trivial``: fixing a small typo or internal change that might be noteworthy.
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -16,8 +16,8 @@ title_format = "pytest {version} ({project_date})"
 | 
			
		|||
template = "changelog/_template.rst"
 | 
			
		||||
 | 
			
		||||
  [[tool.towncrier.type]]
 | 
			
		||||
  directory = "removal"
 | 
			
		||||
  name = "Removals"
 | 
			
		||||
  directory = "breaking"
 | 
			
		||||
  name = "Breaking Changes"
 | 
			
		||||
  showcontent = true
 | 
			
		||||
 | 
			
		||||
  [[tool.towncrier.type]]
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue