1
1
mirror of https://github.com/orhun/git-cliff.git synced 2024-12-17 11:41:42 +03:00
Commit Graph

628 Commits

Author SHA1 Message Date
bors[bot]
5ec4d1f76f
chore(pull): merge #162
162: chore(core): make git2 optional r=orhun a=MarcoIeni

<!--- Thank you for contributing to git-cliff! ⛰️  -->

## Description

<!--- Describe your changes in detail -->
Make git2 optional in git-cliff-core crate.

## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

In release-plz I use git-cliff-core.
However, I don't need git-cliff to read the git history, so I don't need it to include git2.
I depend on both cargo and git-cliff, and often they have conflicting git2 versions.
For example, right now I can't update to the latest git-cliff, because git2 of git-cliff isn't compatible with cargo.

However with this change, by using:
`git-cliff-core =  { path = "../git-cliff/git-cliff-core", default-features = false }`
in release-plz I'm able to update!

Some questions for you:
- are you ok with this additional complexity?
- do you want to find a better name for the feature?

Probably there are other dependencies that can be made optional, but for now git2 is the biggest pain-point for me.
If you are interested, I can find more dependencies.
## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

release-plz is compiling.
Maybe we can add a CI check to test that git-cliff-core compiles even without default features enabled.

## Screenshots / Logs (if applicable)

## Types of Changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation (no code change)
- [x] Refactor (refactoring production code)
- [ ] Other <!--- (provide information) -->

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [x] My code follows the code style of this project.
- [x] I have updated the documentation accordingly.
- [x] I have formatted the code with [rustfmt](https://github.com/rust-lang/rustfmt).
- [x] I checked the lints with [clippy](https://github.com/rust-lang/rust-clippy).
- [x] I have added tests to cover my changes.
- [x] All new and existing tests passed.

## alternative

Extract the code that doesn't depend on git2 in a third crate.
In particular, in my use case I already have the commits I want to write in the changelog, so it would be great if there was a crate that is only focused on generating the changelog, not in determining the commits to write into it.
It would be great if it could expose a subset of the configuration. For example, in release-plz not all git-cliff configuration option will have effect.

Co-authored-by: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>
2023-05-01 10:35:05 +00:00
Marco Ieni
e323621094
ci: check without default features 2023-05-01 10:36:26 +02:00
Marco Ieni
38c7c89d33
fix comment 2023-05-01 10:34:43 +02:00
Orhun Parmaksız
7d7470b2d0
test(repo): add an informative error message to failing test 2023-04-30 19:47:08 +03:00
Marco Ieni
85a13b8b2b
add description 2023-04-30 17:56:11 +02:00
Marco Ieni
db9c7a47de
add doc 2023-04-30 17:47:56 +02:00
Marco Ieni
6482a10834
more optional deps 2023-04-30 17:39:41 +02:00
Marco Ieni
5fdf39ae32
chore(core): make git2 optional 2023-04-28 18:51:51 +02:00
Orhun Parmaksız
c8289ac907
chore(release): prepare for v1.2.0 2023-04-28 16:16:55 +03:00
Orhun Parmaksız
e0a29efe3f
docs(blog): add blog post about what's new in 1.2.0 2023-04-28 16:09:11 +03:00
Orhun Parmaksız
1f897e3d70
chore(cd): temporarily switch back to action-rs/toolchain 2023-04-28 15:20:02 +03:00
Orhun Parmaksız
e42f91013b
refactor(cd): remove unnecessary config update 2023-04-28 15:17:03 +03:00
Orhun Parmaksız
b3eef4a688
fix(release): use the correct argument in release script 2023-04-28 15:17:00 +03:00
bors[bot]
deb0528d11
chore(pull): merge #161
161: chore(deps): bump actions/configure-pages from 1 to 3 r=orhun a=dependabot[bot]

Bumps [actions/configure-pages](https://github.com/actions/configure-pages) from 1 to 3.


Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-04-28 11:57:49 +00:00
bors[bot]
de2ae71170
chore(pull): merge #160
160: chore(deps): bump actions/deploy-pages from 1 to 2 r=orhun a=dependabot[bot]

Bumps [actions/deploy-pages](https://github.com/actions/deploy-pages) from 1 to 2.


Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-04-28 11:52:00 +00:00
dependabot[bot]
bad7c6c288
chore(deps): bump actions/configure-pages from 1 to 3
Bumps [actions/configure-pages](https://github.com/actions/configure-pages) from 1 to 3.
- [Release notes](https://github.com/actions/configure-pages/releases)
- [Commits](https://github.com/actions/configure-pages/compare/v1...v3)

---
updated-dependencies:
- dependency-name: actions/configure-pages
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-04-28 11:49:32 +00:00
dependabot[bot]
b1aeae263c
chore(deps): bump actions/deploy-pages from 1 to 2
Bumps [actions/deploy-pages](https://github.com/actions/deploy-pages) from 1 to 2.
- [Release notes](https://github.com/actions/deploy-pages/releases)
- [Commits](https://github.com/actions/deploy-pages/compare/v1...v2)

---
updated-dependencies:
- dependency-name: actions/deploy-pages
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-04-28 11:49:28 +00:00
Orhun Parmaksız
fe5a4dd8f0
chore(github): integrate Dependabot 2023-04-28 14:49:00 +03:00
Orhun Parmaksız
1ab6f39c84
chore(github): integrate bors 2023-04-28 14:47:37 +03:00
Orhun Parmaksız
d3cb25bc99
chore(github): add contact links for issues 2023-04-28 14:35:52 +03:00
Orhun Parmaksız
95e8408ae6
chore(docker): update versions in Dockerfile 2023-04-28 14:29:37 +03:00
Orhun Parmaksız
84f20f906f
chore(cargo): update MSRV to 1.64.0 2023-04-28 14:27:35 +03:00
Orhun Parmaksız
c1fa97071f
chore(deps): upgrade transitive dependencies 2023-04-28 14:19:13 +03:00
Orhun Parmaksız
269a1afd91
chore(deps): update clap dependencies 2023-04-28 14:18:22 +03:00
Orhun Parmaksız
5b06d3cdb2
chore(deps): upgrade workspace dependencies 2023-04-28 13:48:07 +03:00
Orhun Parmaksız
0e8ddb69e4
chore(deps): upgrade core dependencies 2023-04-28 13:42:50 +03:00
Orhun Parmaksız
74cf47e380
docs(blog): update the blog post style 2023-04-28 13:31:53 +03:00
Orhun Parmaksız
c4024523fa
docs(config): update the sections 2023-04-28 13:31:05 +03:00
Orhun Parmaksız
53c0c1d075
style(docs): fix the grammar for tj-actions 2023-04-28 13:30:35 +03:00
Orhun Parmaksız
3ee6724837
style(docs): update the formatting for python integration example 2023-04-28 13:27:16 +03:00
Orhun Parmaksız
8038659703
chore(examples): remove EXAMPLES.md
Moved to https://git-cliff.org/docs/templating/examples
2023-04-27 00:42:39 +03:00
Orhun Parmaksız
0d4e689115
feat(config): add a custom configuration file for the repository 2023-04-27 00:39:55 +03:00
Orhun Parmaksız
7e3adb0442
docs(config): add comments to the default configuration file 2023-04-27 00:16:24 +03:00
Orhun Parmaksız
54f735ab1a
docs(github): update the pull request template about GitHub labels 2023-04-27 00:06:24 +03:00
Orhun Parmaksız
e35d83d2cf
chore(editorconfig): fix editorconfig syntax 2023-04-26 16:47:48 +03:00
Orhun Parmaksız
8a4f928f9e
chore(editorconfig): update editorconfig for better code readability 2023-04-26 16:36:20 +03:00
Orhun Parmaksız
24ba43330a
style(website): update the style for environment variable section 2023-04-22 21:19:43 +03:00
Mack Solomon
bb9a889f1b
fix(config)!: nested environment config overrides (#157)
* chore: update env variable override format

* tests: add a copule env override assertions

* docs: add a doc for env overrides

* docs: wording

* docs: wording

* fix: prefix

* docs: format first
2023-04-22 20:16:08 +02:00
Orhun Parmaksız
2d721259ca
refactor(ci): test the website deployment with a different job 2023-04-15 20:32:18 +03:00
Orhun Parmaksız
a5a78fc4c5
docs(contributing): mention the nightly requirement for rustfmt 2023-04-12 16:40:05 +03:00
Orhun Parmaksız
72af8ac129
refactor(website): update header location 2023-04-10 21:25:05 +03:00
Orhun Parmaksız
c41bbe05a2
style(readme): update the style for project name 2023-04-10 05:34:17 +03:00
Orhun Parmaksız
ee5ea855b8
docs(website): add Twitter link to banner 2023-04-09 20:06:54 +03:00
Orhun Parmaksız
56240fd11f
docs(readme): update README.md about documentation website 2023-04-09 19:01:29 +03:00
Orhun Parmaksız
6f8a2f96da
test(deploy): test the website deployment for pull requests 2023-04-09 18:49:51 +03:00
Orhun Parmaksız
77dda53843
fix(website): fix broken links 2023-04-09 18:39:39 +03:00
Orhun Parmaksız
020b02d3e3
fix(deploy): set the node cache dependency path 2023-04-09 18:29:11 +03:00
Orhun Parmaksız
f550458414
chore(website): add workflow file for deploying the website 2023-04-09 18:25:29 +03:00
Orhun Parmaksız
5644d10365
chore(website): move website to website folder
This reverts commit b6e52e128e.
2023-04-09 18:16:31 +03:00
Orhun Parmaksız
b6e52e128e
chore(website): move website to docs for GitHub pages deployment 2023-04-09 18:13:52 +03:00