You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-165Lines changed: 6 additions & 165 deletions
Original file line number
Diff line number
Diff line change
@@ -3,119 +3,36 @@ Changelog-it
3
3
4
4
Changelog-it is a command line tool that helps you manage a changelog file for your project. It makes it easy to add new entries to the changelog, and it also provides commands to help you format and present the changelog in a way that is easy for users to read.
5
5
6
-
The tool is written in JavaScript and can be installed using npm. Once it's installed, you can run changelog-it from the command line to see a list of available commands.
6
+
The tool is written in Rust and can be installed using `cargo`. Once it's installed, you can run changelog-it from the command line to see a list of available commands.
7
7
8
8
Some of the features of the tool include:
9
9
10
-
- Adding entries to the changelog: The add command allows you to add a new entry to the changelog. You can specify the type of entry (e.g. `Added`, `Changed`, `Fixed`), a summary of the change, and an optional description.
11
10
- Formatting the changelog: The format command can be used to format the changelog in a way that is easy to read. It groups entries by type and sorts them by date.
12
11
- Generating a release file: You can use the release command to generate a markdown file with the latest changes and upload it to your repository.
13
12
- Customizable templates: You can set custom templates in order to format the generated changelog to your specific needs.
14
13
- The tool is flexible and easy to use, and it's a great way to keep track of the changes in your project.
15
14
16
-
You can start using the tool by installing it with npm, and following the documentation provided in the page for further usage.
17
-
18
15
here are some available integrations we do to generate the release:
take a look on [this](https://github.com/falcucci/changelog-it/blob/master/changelog.example.md) file to check how it will looks like
30
-
31
-
You can also have it automatically post to slack by using the `--slack` flag.
32
-
33
-
## How it works
17
+
| Github
18
+
| --------------
34
19
35
-
The script looks for Jira issue keys, surrounded by square brackets (i.e. `[DEV-123]`), in the git commit logs. When it finds one, it associates that Jira issue ticket with that commit and adds it to the changelog.
20
+
take a look on [this](https://github.com/falcucci/changelog-it/blob/master/templates/example.md) file to check how it will looks like
36
21
37
22
## Installation
38
23
39
24
```bash
40
-
npm install -g -S @falcucci/changelog-it
41
-
```
42
-
43
-
## Configuration
44
-
45
-
You'll need to configure Jira before you can use this effectively. Create a file called `changelog.config.js` and put it at the root of your workspace directory; where you'll call the `jira-changelog` command from.
46
-
47
-
Here's a simple example with sample Jira API values:
48
-
49
-
```javascript
50
-
module.exports= {
51
-
jira: {
52
-
api: {
53
-
host:"yoursite.atlassian.net",
54
-
username:"jirauser",
55
-
password:"s00persecurePa55w0rdBr0"
56
-
},
57
-
}
58
-
}
25
+
cargo install changelog-it
59
26
```
60
27
61
28
To see all values suported, look at the `changelog.config.js` file at the root of this repo.
Assuming you deploy from the prod branch, this will generate a changelog with all commits after the last production deploy to the current master version.
70
-
71
-
If you define `sourceControl.defaultRange` in your config, you can run the command with the `--range` flag:
72
-
73
-
```bash
74
-
changelog-it
75
-
```
76
-
77
30
## Releases
78
31
79
32
You can automatically attach Jira issues to a release with the `--release` flag. For example, let's say we want to add all issues in the changelog to the "sprint-12" release:
0 commit comments