Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
coordt committed Mar 24, 2023
0 parents commit d7dec79
Show file tree
Hide file tree
Showing 46 changed files with 1,610 additions and 0 deletions.
128 changes: 128 additions & 0 deletions .changelog-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# For more configuration information, please see https://coordt.github.io/generate-changelog/

# User variables for reference in other parts of the configuration.
variables:
repo_url: https://github.com/callowayproject/bump-my-version
changelog_filename: CHANGELOG.md

# Pipeline to find the most recent tag for incremental changelog generation.
# Leave empty to always start at first commit.
starting_tag_pipeline:
- action: ReadFile
kwargs:
filename: "{{ changelog_filename }}"
- action: FirstRegExMatch
kwargs:
pattern: (?im)^## (?P<rev>\d+\.\d+(?:\.\d+)?)\s+\(\d+-\d{2}-\d{2}\)$
named_subgroup: rev

# Used as the version title of the changes since the last valid tag.
unreleased_label: Unreleased

# Process the commit's first line for use in the changelog.
summary_pipeline:
- action: strip_spaces
- action: Strip
comment: Get rid of any periods so we don't get double periods
kwargs:
chars: .
- action: SetDefault
args:
- no commit message
- action: capitalize
- action: append_dot

# Process the commit's body for use in the changelog.
body_pipeline:
- action: ParseTrailers
comment: Parse the trailers into metadata.
kwargs:
commit_metadata: save_commit_metadata

# Process and store the full or partial changelog.
output_pipeline:
- action: IncrementalFileInsert
kwargs:
filename: "{{ changelog_filename }}"
last_heading_pattern: (?im)^## \d+\.\d+(?:\.\d+)?\s+\([0-9]+-[0-9]{2}-[0-9]{2}\)$

# Full or relative paths to look for output generation templates.
template_dirs:
- ".github/changelog_templates/"

# Group the commits within a version by these commit attributes.
group_by:
- metadata.category

# Only tags matching this regular expression are used for the changelog.
tag_pattern: ^[0-9]+\.[0-9]+(?:\.[0-9]+)?$

# Tells ``git-log`` whether to include merge commits in the log.
include_merges: false

# Ignore commits whose summary line matches any of these regular expression patterns.
ignore_patterns:
- '[@!]minor'
- '[@!]cosmetic'
- '[@!]refactor'
- '[@!]wip'
- ^$
- ^Merge branch
- ^Merge pull
- ^Version updated

# Set the commit's category metadata to the first classifier that returns ``True``.
commit_classifiers:
- action: SummaryRegexMatch
category: New
kwargs:
pattern: (?i)^(?:new|add)[^\n]*$
- action: SummaryRegexMatch
category: Updates
kwargs:
pattern: (?i)^(?:update|change|rename|remove|delete|improve|refactor|chg|modif)[^\n]*$
- action: SummaryRegexMatch
category: Fixes
kwargs:
pattern: (?i)^(?:fix)[^\n]*$
- action:
category: Other

# Tokens in git commit trailers that indicate authorship.
valid_author_tokens:
- author
- based-on-a-patch-by
- based-on-patch-by
- co-authored-by
- co-committed-by
- contributions-by
- from
- helped-by
- improved-by
- original-patch-by

# Rules applied to commits to determine the type of release to suggest.
release_hint_rules:
- match_result: dev
no_match_result: no-release
branch: ^((?!master|main).)*$
- match_result: patch
no_match_result: no-release
grouping: Other
branch: master|main
- match_result: patch
no_match_result: no-release
grouping: Fixes
branch: master|main
- match_result: minor
no_match_result: no-release
grouping: Updates
branch: master|main
- match_result: minor
no_match_result: no-release
grouping: New
branch: master|main
- match_result: major
no_match_result: no-release
grouping: Breaking Changes
branch: master|main
102 changes: 102 additions & 0 deletions .composition.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
checkout: null
commit: 81c961644e8b14b3d8c77783013ca32a567f1ceb
context:
_copy_without_render:
- .github/**/*.jinja
_dev_requirements:
bump2version: '>=1.0.1'
generate-changelog: '>=0.7.6'
git-fame: '>=1.12.2'
pip-tools: ''
_docs_requirements: {}
_prod_requirements:
environs: '>=9.3.5'
_test_requirements:
coverage: ~=6.1.2
poetry: ~=1.3.2
pre-commit: ~=2.15.0
pytest: ~=6.0.0
pytest-cov: ~=3.0.0
author: Corey Oordt
email: coreyoordt@gmail.com
friendly_name: Bump My Version
github_user: callowayproject
packaging_tool: pip/setuptools
project_name: bump-my-version
project_short_description: Version bump your Python project
project_slug: bump_version
version: 0.1.0
directory: cookiecutter-boilerplate
merge_strategies:
'*.json': comprehensive
'*.yaml': comprehensive
'*.yml': comprehensive
no_input: false
overwrite: []
overwrite_exclude: []
password: null
skip_generation: []
skip_hooks: false
skip_if_file_exists: true
template: /Users/OORDCOR/Projects/datascience-cookiecomposer-templates/
---
checkout: null
commit: 81c961644e8b14b3d8c77783013ca32a567f1ceb
context:
_copy_without_render:
- .github/**/*.yaml
_prod_requirements:
rich-click: ''
friendly_name: Bump My Version
project_name: bump-my-version
project_short_description: Version bump your Python project
project_slug: bump_version
version: 0.1.0
directory: cookiecutter-cli
merge_strategies:
'*.cfg': comprehensive
'*.json': comprehensive
'*.yaml': comprehensive
'*.yml': comprehensive
no_input: false
overwrite: []
overwrite_exclude: []
password: null
skip_generation: []
skip_hooks: false
skip_if_file_exists: true
template: /Users/OORDCOR/Projects/datascience-cookiecomposer-templates/
---
checkout: null
commit: 81c961644e8b14b3d8c77783013ca32a567f1ceb
context:
_copy_without_render:
- docsrc/**/*.rst
_dev_requirements: {}
_docs_requirements:
Sphinx: '>=4.3.0'
furo: ''
ghp-import: ''
linkify-it-py: ''
myst-parser: ''
sphinx-autodoc-typehints: ''
sphinx-click: ''
sphinx-copybutton: ''
_prod_requirements: {}
friendly_name: Bump My Version
github_user: callowayproject
project_name: bump-my-version
project_slug: bump_version
directory: cookiecutter-docs
merge_strategies:
'*.json': comprehensive
'*.yaml': comprehensive
'*.yml': comprehensive
no_input: false
overwrite: []
overwrite_exclude: []
password: null
skip_generation: []
skip_hooks: false
skip_if_file_exists: true
template: /Users/OORDCOR/Projects/datascience-cookiecomposer-templates/
1 change: 1 addition & 0 deletions .cookiecutter.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"_copy_without_render":[".github/**/*.yaml",".github/**/*.jinja","docsrc/**/*.rst"],"_dev_requirements":{"bump2version":">=1.0.1","generate-changelog":">=0.7.6","git-fame":">=1.12.2","pip-tools":""},"_docs_requirements":{"Sphinx":">=4.3.0","furo":"","ghp-import":"","linkify-it-py":"","myst-parser":"","sphinx-autodoc-typehints":"","sphinx-click":"","sphinx-copybutton":""},"_prod_requirements":{"environs":">=9.3.5","rich-click":""},"_test_requirements":{"coverage":"~=6.1.2","poetry":"~=1.3.2","pre-commit":"~=2.15.0","pytest":"~=6.0.0","pytest-cov":"~=3.0.0"},"author":"Corey Oordt","email":"coreyoordt@gmail.com","friendly_name":"Bump My Version","github_user":"callowayproject","packaging_tool":"pip/setuptools","project_name":"bump-my-version","project_short_description":"Version bump your Python project","project_slug":"bump_version","version":"0.1.0"}
23 changes: 23 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# http://editorconfig.org

root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.{py,rst,ini}]
indent_style = space
indent_size = 4

[*.{html,css,scss,json,yml}]
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
* bump-my-version version:
* Python version:
* Operating System:

### Description

Describe what you were trying to get done.
Tell us what happened, what went wrong, and what you expected to happen.

### What I Did

```
Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.
```
8 changes: 8 additions & 0 deletions .github/changelog_templates/commit.md.jinja
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- {{ commit.summary }} [{{ commit.short_sha }}]({{ repo_url }}/commit/{{ commit.sha }})
{{ commit.body|indent(2, first=True) }}
{% for key, val in commit.metadata["trailers"].items() %}
{% if key not in VALID_AUTHOR_TOKENS %}
**{{ key }}:** {{ val|join(", ") }}

{% endif %}
{% endfor %}
4 changes: 4 additions & 0 deletions .github/changelog_templates/version_heading.md.jinja
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## {{ version.label }} ({{ version.date_time.strftime("%Y-%m-%d") }})
{% if version.previous_tag %}
[Compare the full difference.]({{ repo_url }}/compare/{{ version.previous_tag }}...{{ version.tag }})
{% endif %}
Loading

0 comments on commit d7dec79

Please sign in to comment.