Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: pawamoy/git-changelog
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 0.1.1
Choose a base ref
...
head repository: pawamoy/git-changelog
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 0.2.0
Choose a head ref

Commits on Jul 2, 2018

  1. Ignore examples directory

    pawamoy committed Jul 2, 2018
    Copy the full SHA
    28b5c6d View commit details

Commits on Sep 18, 2018

  1. Copy the full SHA
    ef8dbb8 View commit details

Commits on Mar 6, 2019

  1. chore: Use poetry (WIP)

    pawamoy committed Mar 6, 2019
    Copy the full SHA
    0787ef6 View commit details
  2. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    312f949 View commit details
  3. docs: Clean up

    pawamoy committed Mar 6, 2019
    Copy the full SHA
    b3f292b View commit details
  4. chore: Clean up Makefile

    pawamoy committed Mar 6, 2019
    Copy the full SHA
    ced1c48 View commit details
  5. Copy the full SHA
    555342c View commit details
  6. Copy the full SHA
    c0034e2 View commit details
  7. Copy the full SHA
    10bc3f4 View commit details
  8. chore: Clean up

    pawamoy committed Mar 6, 2019
    Copy the full SHA
    12146c4 View commit details
  9. Copy the full SHA
    db0ae92 View commit details
  10. test: Fix tests

    pawamoy committed Mar 6, 2019
    Copy the full SHA
    87dc6d7 View commit details
  11. Copy the full SHA
    c356998 View commit details
  12. Copy the full SHA
    f3a540a View commit details
  13. style: Lint

    pawamoy committed Mar 6, 2019

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    8f48a36 View commit details
  14. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    5667553 View commit details
  15. docs: Fix docs build

    pawamoy committed Mar 6, 2019

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    bebc82a View commit details

Commits on Oct 23, 2019

  1. chore: Update dependencies

    pawamoy committed Oct 23, 2019

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    d1efa23 View commit details
  2. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    1d9d94a View commit details
  3. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    0d55c5e View commit details

Commits on Nov 21, 2019

  1. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    4fbf0ee View commit details
  2. Copy the full SHA
    b94dc7f View commit details
  3. Merge pull request #7 from LoicViennois/fix-angular-style-feature

    Fix angular style feature detection
    pawamoy authored Nov 21, 2019
    Copy the full SHA
    4166e5d View commit details
  4. chore: Update docs

    pawamoy committed Nov 21, 2019
    Copy the full SHA
    11c691b View commit details
  5. Copy the full SHA
    c711a8c View commit details
  6. style: Lint

    pawamoy committed Nov 21, 2019
    Copy the full SHA
    2b5e007 View commit details

Commits on Nov 23, 2019

  1. Copy the full SHA
    d1add10 View commit details
  2. chore: Update packaging

    pawamoy committed Nov 23, 2019
    Copy the full SHA
    7d07cf2 View commit details

Commits on Nov 24, 2019

  1. docs: Update changelog

    pawamoy committed Nov 24, 2019
    Copy the full SHA
    eb80522 View commit details
Showing with 2,686 additions and 659 deletions.
  1. +24 −0 .cruft.json
  2. +2 −0 .flake8
  3. +8 −7 .gitignore
  4. +65 −0 .gitlab-ci.yml
  5. +26 −19 CHANGELOG.md
  6. +76 −0 CODE_OF_CONDUCT.md
  7. +58 −0 CONTRIBUTING.md
  8. +112 −0 CREDITS.md
  9. +0 −7 MANIFEST.in
  10. +93 −0 Makefile
  11. +0 −13 Pipfile
  12. +95 −40 README.md
  13. +25 −0 coverage.ini
  14. +1 −0 docs/changelog.md
  15. +1 −0 docs/code_of_conduct.md
  16. +46 −0 docs/conf.py
  17. +1 −0 docs/contributing.md
  18. +1 −0 docs/credits.md
  19. +55 −0 docs/extra.css
  20. +7 −0 docs/index.md
  21. +1 −0 docs/readme.md
  22. +4 −0 docs/requirements.txt
  23. +2 −0 docs/spelling_wordlist.txt
  24. +1,078 −0 poetry.lock
  25. +74 −0 pyproject.toml
  26. +14 −0 pytest.ini
  27. +8 −0 readthedocs.yml
  28. +60 −0 scripts/gen-credits-data.py
  29. +28 −0 scripts/gen-readme-data.py
  30. +31 −0 scripts/templates/CREDITS.md
  31. +104 −0 scripts/templates/README.md
  32. +44 −0 scripts/templates/coverage.css
  33. +1 −0 scripts/templates/vlz/Jinja2.txt
  34. +1 −0 scripts/templates/vlz/commonmark.txt
  35. +0 −66 setup.py
  36. +7 −0 src/git_changelog/__init__.py
  37. +2 −2 src/{gitolog → git_changelog}/__main__.py
  38. +104 −101 src/{gitolog → git_changelog}/build.py
  39. +101 −0 src/git_changelog/cli.py
  40. +181 −0 src/git_changelog/providers.py
  41. +109 −0 src/git_changelog/style.py
  42. +3 −4 src/{gitolog → git_changelog}/templates/__init__.py
  43. 0 src/{gitolog → git_changelog}/templates/angular/changelog.md
  44. 0 src/{gitolog → git_changelog}/templates/angular/commit.md
  45. 0 src/{gitolog → git_changelog}/templates/angular/section.md
  46. 0 src/{gitolog → git_changelog}/templates/angular/version.md
  47. 0 src/{gitolog → git_changelog}/templates/keepachangelog/changelog.md
  48. 0 src/{gitolog → git_changelog}/templates/keepachangelog/commit.md
  49. 0 src/{gitolog → git_changelog}/templates/keepachangelog/section.md
  50. 0 src/{gitolog → git_changelog}/templates/keepachangelog/version.md
  51. +0 −6 src/gitolog/__init__.py
  52. +0 −93 src/gitolog/cli.py
  53. +0 −173 src/gitolog/providers.py
  54. +0 −117 src/gitolog/style.py
  55. +22 −0 tests/test_angular_style.py
  56. +11 −11 tests.py → tests/test_main.py
24 changes: 24 additions & 0 deletions .cruft.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"template": "https://github.com/pawamoy/cookie-poetry",
"commit": "97493f9f8f3ee8e2119f76431353166d50f40383",
"context": {
"cookiecutter": {
"project_name": "git-changelog",
"project_description": "Automatic Changelog generator using Jinja2 templates.",
"author_fullname": "Timothée Mazzucotelli",
"author_email": "pawamoy@pm.me",
"author_username": "pawamoy",
"repository_provider": "github.com",
"repository_namespace": "pawamoy",
"repository_name": "git-changelog",
"copyright_holder": "Timothée Mazzucotelli",
"copyright_holder_email": "pawamoy@pm.me",
"copyright_date": "2018",
"copyright_license": "ISC License",
"python_package_distribution_name": "git-changelog",
"python_package_import_name": "git_changelog",
"python_package_command_line_name": "git-changelog",
"_template": "https://github.com/pawamoy/cookie-poetry"
}
}
}
2 changes: 2 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[flake8]
max-line-length = 120
15 changes: 8 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.idea/
Pipfile.lock
example/
example2/
example3/
output.md
__pycache__/
src/dist/
build/
*.py[cod]
dist/
*.egg-info/
build/
.coverage
tests/tmp/*
!tests/tmp/.gitkeep
pip-wheel-metadata/
.pytest_cache/
.python-version
65 changes: 65 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
variables:
PIP_CACHE_DIR: "${CI_PROJECT_DIR}/.cache/pip"

cache:
key: "${CI_JOB_NAME}"
paths:
- .cache/pip
- .venv

stages:
- quality
- tests

.install-deps-template: &install-deps
before_script:
- pip install poetry
- poetry --version
- poetry config settings.virtualenvs.in-project true
- poetry install -vv

# Quality jobs

.quality-template: &quality
<<: *install-deps
image: python:3.6
stage: quality

check-bandit:
<<: *quality
script: make check-bandit

check-black:
<<: *quality
script: make check-black

check-flake8:
<<: *quality
script: make check-flake8

check-isort:
<<: *quality
script: make check-isort

check-safety:
<<: *quality
script: make check-safety

# Tests jobs

.test-template: &test
<<: *install-deps
stage: tests
script: make test

python3.6:
<<: *test
image: python:3.6

python3.7:
<<: *test
image: python:3.7

python3.8:
<<: *test
image: python:3.8
45 changes: 26 additions & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -4,34 +4,41 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.1.1](https://gitlab.com/pawamoy/gitolog/tags/0.1.1) ([compare](https://gitlab.com/pawamoy/gitolog/compare/0.1.0...0.1.1))
## [0.2.0](https://github.com/pawamoy/git-changelog/releases/tag/0.2.0) ([compare](https://github.com/pawamoy/git-changelog/compare/0.1.1...0.2.0))

Drop support for Python < 3.6.

Use [poetry](https://github.com/sdispater/poetry) to manage the project!

### Fixed
- Fix build with MANIFEST.in, add license file ([013fb69](https://gitlab.com/pawamoy/gitolog/commit/013fb691826924d6f71b4159a8fa650e40324db3)).
- Fix detection of feature (is_minor) for angular style ([4fbf0ee](https://github.com/pawamoy/git-changelog/commit/4fbf0ee4ae582c1925e80b885bb4da42b69ecc09)).

## [0.1.1](https://github.com/pawamoy/git-changelog/tags/0.1.1) ([compare](https://github.com/pawamoy/git-changelog/compare/0.1.0...0.1.1))

### Fixed
- Fix build with MANIFEST.in, add license file ([013fb69](https://github.com/pawamoy/git-changelog/commit/013fb691826924d6f71b4159a8fa650e40324db3)).

### Misc
- Improve readability ([5e590f6](https://gitlab.com/pawamoy/gitolog/commit/5e590f6ac62b23e608a507e08123efba3b0f7e0d)).
- Improve readability ([5e590f6](https://github.com/pawamoy/git-changelog/commit/5e590f6ac62b23e608a507e08123efba3b0f7e0d)).


## [0.1.0](https://gitlab.com/pawamoy/gitolog/tags/0.1.0) ([compare](https://gitlab.com/pawamoy/gitolog/compare/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446...0.1.0)) - 2018-06-27
## [0.1.0](https://github.com/pawamoy/git-changelog/tags/0.1.0) ([compare](https://github.com/pawamoy/git-changelog/compare/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446...0.1.0)) - 2018-06-27

### Added
- Add github/gitlab regexes ([584fd73](https://gitlab.com/pawamoy/gitolog/commit/584fd73ec88ac51abbf8555d8f78b7144529e6b3)).
- Add github/github regexes ([584fd73](https://github.com/pawamoy/git-changelog/commit/584fd73ec88ac51abbf8555d8f78b7144529e6b3)).

### Fixed
- Fix patch bump ([8470e69](https://gitlab.com/pawamoy/gitolog/commit/8470e695128d9892296acdd31c404d85add68983)).
- Fix refs parsing ([8c77cb7](https://gitlab.com/pawamoy/gitolog/commit/8c77cb736971473837384a8238c3c53886d77c75)).
- Fix patch bump ([8470e69](https://github.com/pawamoy/git-changelog/commit/8470e695128d9892296acdd31c404d85add68983)).
- Fix refs parsing ([8c77cb7](https://github.com/pawamoy/git-changelog/commit/8c77cb736971473837384a8238c3c53886d77c75)).

### Misc
- Continue packaging (#6) ([a29af2c](https://gitlab.com/pawamoy/gitolog/commit/a29af2cf990edf950b55a46ebea164ab068c9aec)).
- Finish packaging (#6) ([e92b492](https://gitlab.com/pawamoy/gitolog/commit/e92b4923a60d561c38150331dac9cd2e3ba6c130)).
- Implement reference parsing ([a9b4a89](https://gitlab.com/pawamoy/gitolog/commit/a9b4a89cd2737056166feb7a46da971549f1ffed)).
- Improve angular template, improve style/refs system ([5b87d48](https://gitlab.com/pawamoy/gitolog/commit/5b87d48acdf3aa0f5cc2731f48e372c4065d9f9b)).
- Initial commit ([83845fe](https://gitlab.com/pawamoy/gitolog/commit/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446)).
- Package code (#6) ([1219eaf](https://gitlab.com/pawamoy/gitolog/commit/1219eafd02521f6f6ab942a02b7a7aee3d664143)).
- Update changelog for version 0.1.0 ([14edcaf](https://gitlab.com/pawamoy/gitolog/commit/14edcaf078d02c42abf1692664c620c509df88a0)).
- Update changelog for version 0.1.0 ([610633d](https://gitlab.com/pawamoy/gitolog/commit/610633da8a569e7f2966f1675a30aca651563e0b)).
- Update changelog for version 0.1.0 ([2eaaa2e](https://gitlab.com/pawamoy/gitolog/commit/2eaaa2e76fc35d111517ecd0a15daf65e705723c)).
- Work in progress ([27a60e8](https://gitlab.com/pawamoy/gitolog/commit/27a60e80e9a8308b88942311184346b1bfa4b0a8)).


- Continue packaging (#6) ([a29af2c](https://github.com/pawamoy/git-changelog/commit/a29af2cf990edf950b55a46ebea164ab068c9aec)).
- Finish packaging (#6) ([e92b492](https://github.com/pawamoy/git-changelog/commit/e92b4923a60d561c38150331dac9cd2e3ba6c130)).
- Implement reference parsing ([a9b4a89](https://github.com/pawamoy/git-changelog/commit/a9b4a89cd2737056166feb7a46da971549f1ffed)).
- Improve angular template, improve style/refs system ([5b87d48](https://github.com/pawamoy/git-changelog/commit/5b87d48acdf3aa0f5cc2731f48e372c4065d9f9b)).
- Initial commit ([83845fe](https://github.com/pawamoy/git-changelog/commit/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446)).
- Package code (#6) ([1219eaf](https://github.com/pawamoy/git-changelog/commit/1219eafd02521f6f6ab942a02b7a7aee3d664143)).
- Update changelog for version 0.1.0 ([14edcaf](https://github.com/pawamoy/git-changelog/commit/14edcaf078d02c42abf1692664c620c509df88a0)).
- Update changelog for version 0.1.0 ([610633d](https://github.com/pawamoy/git-changelog/commit/610633da8a569e7f2966f1675a30aca651563e0b)).
- Update changelog for version 0.1.0 ([2eaaa2e](https://github.com/pawamoy/git-changelog/commit/2eaaa2e76fc35d111517ecd0a15daf65e705723c)).
- Work in progress ([27a60e8](https://github.com/pawamoy/git-changelog/commit/27a60e80e9a8308b88942311184346b1bfa4b0a8)).
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at pawamoy@pm.me. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contributing
Contributions are welcome, and they are greatly appreciated!

Every little bit helps, and credit will always be given.

## Types of Contributions

### Bug Reports, Feature Requests, and Feedback
Create a new [GitHub issue][1] or [GitLab issue][2]! Try to be as descriptive as possible.

### Bug Fixes, New Features and Documentation
This project is developed using [`poetry`](https://github.com/sdispater/poetry).
Follow the recommended installation method:

```bash
curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
```

1. Fork the repository [on GitHub][3] or [on GitLab][4];
1. Clone it on your machine;
1. Go into the directory, and run `poetry install` to setup the development environment;
1. Create a new branch with `git checkout -b bug-fix-or-feature-name`;
1. Code!
1. **Write tests. Run them all.** The commands to run the tests are:
```bash
poetry run pytest # to run all tests sequentially
poetry run pytest -v # to print one test per line
poetry run pytest -n 4 # to run tests in parallel (4 workers)
poetry run pytest tests/test_api.py # to run tests in a specific file
```

`pytest` provides the `-k` option to select tests based on their names:

```bash
poetry run pytest -k "api and remove"
poetry run pytest -k "utils or stats"
```

See the [documentation for the `-k` option][5] for more examples.

7. When the tests pass, commit;
8. Push;
9. ...and finally, create a new [pull request][6] / [merge request][7]!
Make sure to follow the guidelines.

## Merge/Pull Request Guidelines
Make sure to have atomic commits and contextual commit messages!

[Check out this awesome blog post by Chris Beams for more information.][8]

[1]: https://github.com/pawamoy/git-changelog/issues/new
[2]: https://gitlab.com/pawamoy/git-changelog/issues/new
[3]: https://github.com/pawamoy/git-changelog
[4]: https://gitlab.com/pawamoy/git-changelog
[5]: https://docs.pytest.org/en/latest/example/markers.html#using-k-expr-to-select-tests-based-on-their-name
[6]: https://github.com/pawamoy/git-changelog/compare
[7]: https://gitlab.com/pawamoy/git-changelog/compare
[8]: http://chris.beams.io/posts/git-commit/
Loading