FilesExpand file tree

master

/

cliff.toml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

102 lines (98 loc) · 4.07 KB

master

/

cliff.toml

Copy path

Top

File metadata and controls

• Code
• Blame

102 lines (98 loc) · 4.07 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

# git-cliff ~ default configuration file

# https://git-cliff.org/docs/configuration

#

# Lines starting with "#" are comments.

# Configuration options are organized into tables and keys.

# See documentation for more information on available options.

[changelog]

# changelog header

header = """

# Changelog\n

All notable changes to this project will be documented in this file.\n

"""

# template for the changelog body

# https://keats.github.io/tera/docs/#introduction

body = """

{% if version %}\

## [{{ version | trim_start_matches(pat="v") }}](<REPO>/releases/tag/{{ version }}) ({{ timestamp | date(format="%Y-%m-%d") }})

{% elif message %}\

## {{ message | trim_start_matches(pat="v") }} - **not yet released**

{% else %}\

## unreleased

{% endif %}\

{% for group, commits in commits | group_by(attribute="group") %}

### {{ group | striptags | trim | upper_first }}

{% for commit in commits %}

- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\

{% if commit.breaking %}[**breaking**] {% endif %}\

{{ commit.message | upper_first }} ([{{ commit.id | truncate(length = 7, end = "") }}](<REPO>/commit/{{ commit.id }}))\

{% if commit.github.username %} by [@{{ commit.github.username }}](https://github.com/{{ commit.github.username }}){%- endif %}\

{% endfor %}

{% endfor %}\n

"""

# template for the changelog footer

footer = """

<!-- generated by git-cliff -->

"""

# remove the leading and trailing s

trim = true

# postprocessors

postprocessors = [

{ pattern = '<REPO>', replace = "https://github.com/apify/crawlee-python" }, # replace repository URL

]

[bump]

# With 0.x.y version, breaking commits should only increase the minor version and feature commits should only increase the patch version

breaking_always_bump_major = false

features_always_bump_minor = false

[git]

# parse the commits based on https://www.conventionalcommits.org

conventional_commits = true

# filter out the commits that are not conventional

filter_unconventional = true

# process each line of a commit as an individual commit

split_commits = false

# regex for preprocessing the commit messages

commit_preprocessors = [

# Replace PR and issue numbers in commit messages

{ pattern = '.*', replace_command = 'python scripts/preprocess_commit_message.py'},

# Check spelling of the commit with https://github.com/crate-ci/typos

# If the spelling is incorrect, it will be automatically fixed.

#{ pattern = '.*', replace_command = 'typos --write-changes -' },

]

# regex for parsing and grouping commits

commit_parsers = [

{ message = "^feat", group = "<!-- 0 -->🚀 Features" },

{ message = "^fix|^bug", group = "<!-- 1 -->🐛 Bug Fixes" },

# { message = "^doc", group = "<!-- 3 -->📚 Documentation" },

{ message = "^doc", skip = true },

{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },

# { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },

{ message = "^refactor", skip = true },

# { message = "^style", group = "<!-- 5 -->🎨 Styling" },

{ message = "^style", skip = true },

# { message = "^test", group = "<!-- 6 -->🧪 Testing" },

{ message = "^test", skip = true },

{ message = "^chore\\(release\\): prepare for", skip = true },

{ message = "^chore\\(deps.*\\)", skip = true },

{ message = "^chore\\(pr\\)", skip = true },

{ message = "^chore\\(pull\\)", skip = true },

# { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },

{ message = "^chore|^ci", skip = true },

{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },

{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },

]

# protect breaking changes from being skipped due to matching a skipping commit_parser

protect_breaking_commits = true

# filter out the commits that are not matched by commit parsers

filter_commits = false

# regex for matching git tags

tag_pattern = "v[0-9]+\\."

# sort the tags topologically

topo_order = false

# sort the commits inside sections by oldest/newest order

sort_commits = "oldest"

# limit the number of commits included in the changelog.

# limit_commits = 42

[remote.github]

owner = "apify"

repo = "crawlee-python"