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: BlueBrain/dir-content-diff
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 1.1.0
Choose a base ref
...
head repository: BlueBrain/dir-content-diff
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref

Commits on Feb 8, 2022

  1. Copy the full SHA
    d8c8452 View commit details

Commits on Feb 9, 2022

  1. Copy the full SHA
    1d33d11 View commit details

Commits on May 5, 2022

  1. Bump black (#16)

    adrien-berchet authored May 5, 2022
    Copy the full SHA
    cb28120 View commit details
  2. Copy the full SHA
    93e5b58 View commit details
  3. Copy the full SHA
    901263e View commit details

Commits on Jul 5, 2022

  1. Copy the full SHA
    9223ba9 View commit details

Commits on Aug 29, 2022

  1. Copy the full SHA
    c5c205a View commit details

Commits on Aug 30, 2022

  1. Refactor: Apply Copier template (#20)

    [skip-changelog]
    adrien-berchet authored Aug 30, 2022
    Copy the full SHA
    52968f5 View commit details
  2. Copy the full SHA
    f07401a View commit details

Commits on Dec 19, 2022

  1. Copy the full SHA
    f0518a8 View commit details
  2. CI: Apply Copier template (#23)

    * Add support for Python 3.10
    * Add dependabot for Github Actions
    * Use cache in Github Actions
    adrien-berchet authored Dec 19, 2022
    Copy the full SHA
    174f646 View commit details
  3. Release: 1.3.0 (#24)

    adrien-berchet authored Dec 19, 2022
    Copy the full SHA
    f5f3b98 View commit details

Commits on Dec 20, 2022

  1. Copy the full SHA
    48d8379 View commit details

Commits on Dec 23, 2022

  1. Copy the full SHA
    ce52cad View commit details

Commits on Mar 13, 2023

  1. Copy the full SHA
    04520d7 View commit details
  2. Copy the full SHA
    273d8b3 View commit details
  3. Release: 1.4.0 (#29)

    adrien-berchet authored Mar 13, 2023
    Copy the full SHA
    77e0e9b View commit details

Commits on May 10, 2023

  1. Copy the full SHA
    a16406a View commit details
  2. Copy the full SHA
    f760dd6 View commit details
  3. Copy the full SHA
    6b8e5c8 View commit details
  4. Copy the full SHA
    0dae5b8 View commit details

Commits on May 11, 2023

  1. Release: 1.5.0 (#37)

    adrien-berchet authored May 11, 2023
    Copy the full SHA
    cd3a79a View commit details

Commits on Sep 11, 2023

  1. Copy the full SHA
    c6bb072 View commit details
  2. CI(deps): Bump actions/checkout from 3 to 4 (#38)

    Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
    - [Release notes](https://github.com/actions/checkout/releases)
    - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
    - [Commits](actions/checkout@v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: actions/checkout
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 11, 2023
    Copy the full SHA
    5927f59 View commit details
  3. CI(deps): Bump mikepenz/action-junit-report from 3 to 4 (#39)

    Bumps [mikepenz/action-junit-report](https://github.com/mikepenz/action-junit-report) from 3 to 4.
    - [Release notes](https://github.com/mikepenz/action-junit-report/releases)
    - [Commits](mikepenz/action-junit-report@v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: mikepenz/action-junit-report
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 11, 2023
    Copy the full SHA
    6c013da View commit details
  4. Copy the full SHA
    4e74ef0 View commit details

Commits on Sep 12, 2023

  1. Chore: Apply Copier template (#42)

    [skip-changelog]
    adrien-berchet authored Sep 12, 2023
    Copy the full SHA
    c3256dd View commit details

Commits on Sep 29, 2023

  1. Chore: Apply Copier template (#43)

    [skip-changelog]
    adrien-berchet authored Sep 29, 2023
    Copy the full SHA
    dd0032c View commit details

Commits on Oct 31, 2023

  1. CI(dependabot): Bump actions/setup-node from 3 to 4 (#44)

    * CI(dependabot): Bump actions/setup-node from 3 to 4
    
    Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3 to 4.
    - [Release notes](https://github.com/actions/setup-node/releases)
    - [Commits](actions/setup-node@v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: actions/setup-node
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    
    * Fix: Lint
    
    ---------
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Adrien Berchet <adrien.berchet@epfl.ch>
    dependabot[bot] and adrien-berchet authored Oct 31, 2023
    Copy the full SHA
    71f3bad View commit details

Commits on Dec 11, 2023

  1. CI(dependabot): Bump actions/setup-python from 4 to 5 (#45)

    Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5.
    - [Release notes](https://github.com/actions/setup-python/releases)
    - [Commits](actions/setup-python@v4...v5)
    
    ---
    updated-dependencies:
    - dependency-name: actions/setup-python
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Dec 11, 2023
    Copy the full SHA
    9458968 View commit details

Commits on Dec 18, 2023

  1. CI(dependabot): Bump actions/upload-artifact from 3 to 4 (#46)

    Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4.
    - [Release notes](https://github.com/actions/upload-artifact/releases)
    - [Commits](actions/upload-artifact@v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: actions/upload-artifact
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Dec 18, 2023
    Copy the full SHA
    92361af View commit details

Commits on Jan 22, 2024

  1. CI(dependabot): Bump actions/cache from 3 to 4 (#47)

    Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4.
    - [Release notes](https://github.com/actions/cache/releases)
    - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md)
    - [Commits](actions/cache@v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: actions/cache
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Jan 22, 2024
    Copy the full SHA
    2bf5b1b View commit details

Commits on Jan 29, 2024

  1. Copy the full SHA
    e12901c View commit details
  2. Release: 1.6.0 (#49)

    adrien-berchet authored Jan 29, 2024
    Copy the full SHA
    85655bc View commit details

Commits on Feb 5, 2024

  1. CI(dependabot): Bump codecov/codecov-action from 3 to 4 (#51)

    Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 3 to 4.
    - [Release notes](https://github.com/codecov/codecov-action/releases)
    - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md)
    - [Commits](codecov/codecov-action@v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: codecov/codecov-action
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Feb 5, 2024
    Copy the full SHA
    2589c00 View commit details
  2. Copy the full SHA
    04e4ae0 View commit details
  3. Copy the full SHA
    2ad26ef View commit details
  4. Copy the full SHA
    8343c8c View commit details

Commits on Feb 8, 2024

  1. Chore: Apply Copier template (#55)

    [skip-changelog]
    adrien-berchet authored Feb 8, 2024
    Copy the full SHA
    76d8569 View commit details

Commits on Apr 8, 2024

  1. Feat: Add new comparators for Feather, Parquet and Stata files (#56)

    * Feat: Add new comparators for Feather, Parquet and Stata files
    
    * Fix: Fix coverage
    adrien-berchet authored Apr 8, 2024
    Copy the full SHA
    cf58e52 View commit details
  2. Copy the full SHA
    47b5735 View commit details

Commits on Apr 26, 2024

  1. Copy the full SHA
    55fe9eb View commit details

Commits on May 1, 2024

  1. Copy the full SHA
    d7f7d9f View commit details

Commits on Aug 29, 2024

  1. Copy the full SHA
    40a64ff View commit details
  2. Release: 1.9.0 (#61)

    adrien-berchet authored Aug 29, 2024
    Copy the full SHA
    e0d0f4d View commit details
  3. Copy the full SHA
    7db2807 View commit details
  4. Release: 1.9.1 (#63)

    adrien-berchet authored Aug 29, 2024
    Copy the full SHA
    d1a407f View commit details

Commits on Sep 9, 2024

  1. Copy the full SHA
    0b3b40e View commit details
  2. Copy the full SHA
    732ee4e View commit details

Commits on Nov 6, 2024

  1. Copy the full SHA
    154eb4f View commit details
Showing with 4,488 additions and 696 deletions.
  1. +3 −2 .auto-changelog
  2. +178 −9 .auto-changelog-template.hbs
  3. 0 .codespellignorelines
  4. +2 −0 .codespellrc
  5. +27 −0 .copier-answers.yml
  6. +6 −0 .copyright.tmpl
  7. +2 −1 .coveragerc
  8. +11 −0 .coveragerc_min_versions
  9. +3 −0 .gitattributes
  10. +114 −0 .github/ISSUE_TEMPLATE/bug_report.yaml
  11. +1 −0 .github/ISSUE_TEMPLATE/config.yml
  12. +56 −0 .github/ISSUE_TEMPLATE/feature_request.yaml
  13. +91 −0 .github/ISSUE_TEMPLATE/how_to_use.yaml
  14. +16 −0 .github/dependabot.yml
  15. +24 −0 .github/pull_request_template.md
  16. +21 −0 .github/workflows/commitlint.yml
  17. +8 −7 .github/workflows/publish-sdist.yml
  18. +72 −16 .github/workflows/run-tox.yml
  19. +36 −8 .gitignore
  20. +53 −0 .pre-commit-config.yaml
  21. +54 −0 .pylintrc
  22. +3 −3 .readthedocs.yml
  23. +3 −5 AUTHORS.md
  24. +182 −9 CHANGELOG.md
  25. +37 −17 CONTRIBUTING.md
  26. +1 −2 LICENSE.txt
  27. +3 −0 MANIFEST.in
  28. +24 −1 README.md
  29. +145 −0 commitlint.config.js
  30. +128 −37 dir_content_diff/__init__.py
  31. +262 −25 dir_content_diff/base_comparators.py
  32. +188 −0 dir_content_diff/cli/__init__.py
  33. +10 −0 dir_content_diff/comparators/__init__.py
  34. +9 −0 dir_content_diff/comparators/dependencies.json
  35. +53 −0 dir_content_diff/comparators/morphio.py
  36. +60 −10 dir_content_diff/{ → comparators}/pandas.py
  37. +156 −0 dir_content_diff/comparators/voxcell.py
  38. +10 −0 dir_content_diff/pytest_plugin.py
  39. +87 −1 dir_content_diff/util.py
  40. +0 −11 doc/source/api.rst
  41. +0 −1 doc/source/changelog.rst
  42. +0 −1 doc/source/contributing.rst
  43. +1 −1 {doc → docs}/Makefile
  44. 0 {doc → docs}/source/.gitignore
  45. +15 −0 docs/source/api_ref.rst
  46. +2 −0 docs/source/changelog.rst
  47. +32 −8 {doc → docs}/source/conf.py
  48. +2 −0 docs/source/contributing.rst
  49. +3 −2 {doc → docs}/source/index.rst
  50. +33 −0 package.json
  51. +75 −49 pyproject.toml
  52. +34 −55 setup.py
  53. +10 −1 tests/__init__.py
  54. +10 −0 tests/comparators/__init__.py
  55. +92 −0 tests/comparators/test_morphio.py
  56. +544 −0 tests/comparators/test_pandas.py
  57. +367 −0 tests/comparators/test_voxcell.py
  58. +46 −4 tests/conftest.py
  59. +41 −0 tests/generate_test_files.py
  60. +550 −51 tests/test_base.py
  61. +276 −0 tests/test_cli.py
  62. +45 −0 tests/test_missing_deps.py
  63. +0 −299 tests/test_pandas.py
  64. +36 −17 tests/test_pytest_plugin.py
  65. +49 −0 tests/test_util.py
  66. +12 −2 tests/test_version.py
  67. +74 −41 tox.ini
5 changes: 3 additions & 2 deletions .auto-changelog
Original file line number Diff line number Diff line change
@@ -3,9 +3,10 @@
"template": ".auto-changelog-template.hbs",
"commitLimit": false,
"backfillLimit": false,
"ignoreCommitPattern": "Release [0-9]+\\.[0-9]+\\.[0-9]+|Update CHANGELOG.*|.*\\[skip-changelog\\].*|Initial empty repository",
"ignoreCommitPattern": "^Release:? [0-9]+\\.[0-9]+\\.[0-9]+( ?\\(#[0-9]+\\))?$|^Update CHANGELOG.*|.*\\[skip-changelog\\].*|^\\[pre-commit.ci\\]|^\\(dependabot\\) .*",
"commitUrl": "https://github.com/BlueBrain/dir-content-diff/commit/{id}",
"issueUrl": "https://github.com/BlueBrain/dir-content-diff/issues/{id}",
"mergeUrl": "https://github.com/BlueBrain/dir-content-diff/pull/{id}",
"compareUrl": "https://github.com/BlueBrain/dir-content-diff/compare/{from}..{to}"
"compareUrl": "https://github.com/BlueBrain/dir-content-diff/compare/{from}..{to}",
"startingVersion": "1.2.0"
}
187 changes: 178 additions & 9 deletions .auto-changelog-template.hbs
Original file line number Diff line number Diff line change
@@ -1,28 +1,197 @@
# Changelog

{{!--
Introduction
• This template tries to follow conventional commits format https://www.conventionalcommits.org/en/v1.0.0/
• The template uses regex to filter commit types into their own headings (this is more than just fixes and features headings)
• It also uses the replaceText function in package.json to remove the commit type text from the message, because the headers are shown instead.
• The text 'Breaking:' or 'Breaking changes:' can be located anywhere in the commit.
• The types feat:, fix:, chore:, docs:, refactor:, test:, style:, perf: must be at the beginning of the commit subject with an : on end.
• They can optionally have a scope set to outline the module or component that is affected eg feat(bldAssess):
• There is a short hash on the end of every commit that is currently commented out so that change log did not grow too long (due to some system's file size limitations). You can uncomment if you wish [`{{shorthash}}`]({{href}})
Example Definitions
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code (white-space, formatting, spelling mistakes, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests
• docs: Adding/updating documentation
• chore: Something like updating a library version, or moving files to be in a better location and updating all file refs
--}}


{{!-- In package.json need to add this to remove label text from the change log output (because the markdown headers are now used to group them).
NOTES • Individual brackets have been escaped twice to be Json compliant.
• For items that define a scope eg feat(bldAssess): We remove the 1st bracket and then re-add it so we can select the right piece of text
{
"name": "my-awesome-package",
"auto-changelog": {
"replaceText": {
"([bB]reaking:)": "",
"([bB]reaking change:)": "",
"(^[bB]uild:)": "",
"(^[bB]uild\\()": "\\(",
"(^[dD]eprecate:)": "",
"(^[dD]eprecate\\()": "\\(",
"(^[fF]eat:)": "",
"(^[fF]eat\\()": "\\(",
"(^[fF]ix:)": "",
"(^[fF]ix\\()": "\\(",
"(^[cC]hore:)": "",
"(^[cC]hore\\()": "\\(",
"(^[dD]ocs:)": "",
"(^[dD]ocs\\()": "\\(",
"(^[rR]efactor:)": "",
"(^[rR]efactor\\()": "\\(",
"(^[tT]est:)": "",
"(^[tT]est\\()": "\\(",
"(^[sS]tyle:)": "",
"(^[sS]tyle\\()": "\\(",
"(^[pP]erf:)": "",
"(^[pP]erf\\()": "\\("
}
}
}
--}}

{{!--
Regex reminders
^ = starts with
\( = ( character (otherwise it is interpreted as a regex lookup group)
* = zero or more of the previous character
\s = whitespace
. = any character except newline
| = or
[aA] = character a or character A
--}}


{{#each releases}}
{{#if href}}
## [{{title}}]({{href}})
{{else}}
## {{title}}
{{/if}}

{{#if tag}}
> {{niceDate}}
{{/if}}
> {{niceDate}}

{{#if summary}}
{{summary}}
{{/if}}

{{#each merges}}
- {{#if commit.breaking}}**Breaking change:** {{/if}}{{message}}{{#if href}} [#{{id}}]({{href}}){{/if}}
{{/each}}
{{! List commits that fix a given issues}}
{{#each fixes}}
- {{#if commit.breaking}}**Breaking change:** {{/if}}{{commit.subject}}{{#each fixes}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}}){{/each}}
{{/each}}
{{#each commits}}
- {{#if breaking}}**Breaking change:** {{/if}}{{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/each}}

{{! List merge commits with 'breaking:' or 'Breaking change:' anywhere in the message under a heading}}
{{#commit-list merges heading='### Breaking Changes :warning:' message='[bB]reaking [cC]hange:|[bB]reaking:' exclude='\[skip-changelog\]'}}
- {{message}} @{{author}} <!--[`#{{id}}`]({{href}}) -->
{{/commit-list}}

{{! List commits organised under a heading, but not those already listed in the breaking section }}
{{#commit-list merges heading='### Build' message='^[bB]uild:|^[bB]uild\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### Deprecated Features' message='^[dD]eprecate:|^[dD]eprecate\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### New Features' message='^[fF]eat:|^[fF]eat\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### Fixes' message='^[fF]ix:|^[fF]ix\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### Chores And Housekeeping' message='^[cC]hore:|^[cC]hore\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### Documentation Changes' message='^[dD]ocs:|^[dD]ocs\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### Refactoring and Updates' message='^[rR]efactor:|^[rR]efactor\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### Changes to Test Assests' message='^[tT]est:|^[tT]est\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### Tidying of Code eg Whitespace' message='^[sS]tyle:|^[sS]tyle\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### Performance Improvements' message='^[pP]erf:|^[pP]erf\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### CI Improvements' message='^[cC][iI]:|^[cC][iI]\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list merges heading='### General Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[bB]uild:|^[bB]uild ?\(|^[dD]eprecate:|^[dD]eprecate ?\(|^[fF]eat:|^[fF]eat ?\(|^[fF]ix:|^[fF]ix ?\(|^[cC]hore:|^[cC]hore ?\(|^[cC][iI]:|^[cC][iI] ?\(|^[dD]ocs:|^[dD]ocs ?\(|^[rR]efactor:|^[rR]efactor ?\(|^[tT]est:|^[tT]est ?\(|^[sS]tyle:|^[sS]tyle ?\(|^[pP]erf:|^[pP]erf ?\(|\[skip-changelog\]'}}
- {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
{{/commit-list}}

{{! List commits with 'breaking:' or 'Breaking change:' anywhere in the message under a heading}}
{{#commit-list commits heading='### Breaking Changes :warning:' message='[bB]reaking [cC]hange:|[bB]reaking:' exclude='\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{! List commits organised under a heading, but not those already listed in the breaking section }}
{{#commit-list commits heading='### Build' message='^[bB]uild:|^[bB]uild\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### Deprecated Features' message='^[dD]eprecate:|^[dD]eprecate\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### New Features' message='^[fF]eat:|^[fF]eat\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### Fixes' message='^[fF]ix:|^[fF]ix\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### Chores And Housekeeping' message='^[cC]hore:|^[cC]hore\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### Documentation Changes' message='^[dD]ocs:|^[dD]ocs\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### Refactoring and Updates' message='^[rR]efactor:|^[rR]efactor\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### Changes to Test Assests' message='^[tT]est:|^[tT]est\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### Tidying of Code eg Whitespace' message='^[sS]tyle:|^[sS]tyle\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### Performance Improvements' message='^[pP]erf:|^[pP]erf\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### CI Improvements' message='^[cC][iI]:|^[cC][iI]\(' exclude='[bB]reaking [cC]hange:|[bB]reaking:|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{#commit-list commits heading='### General Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[bB]uild:|^[bB]uild ?\(|^[dD]eprecate:|^[dD]eprecate ?\(|^[fF]eat:|^[fF]eat ?\(|^[fF]ix:|^[fF]ix ?\(|^[cC]hore:|^[cC]hore ?\(|^[cC][iI]:|^[cC][iI] ?\(|^[dD]ocs:|^[dD]ocs ?\(|^[rR]efactor:|^[rR]efactor ?\(|^[tT]est:|^[tT]est ?\(|^[sS]tyle:|^[sS]tyle ?\(|^[pP]erf:|^[pP]erf ?\(|\[skip-changelog\]'}}
- {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
{{/commit-list}}

{{/each}}
Empty file added .codespellignorelines
Empty file.
2 changes: 2 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[codespell]
skip = .git/*,*.pdf
27 changes: 27 additions & 0 deletions .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Changes here will be overwritten by Copier

_commit: 0.1.67
_src_path: git@bbpgitlab.epfl.ch:neuromath/python-template.git
author_email: ''
author_name: Blue Brain Project, EPFL
copyright_license: Apache License 2.0
copyright_year: '2023'
distribution_name: dir-content-diff
download_url: https://github.com/BlueBrain/dir-content-diff
init_git: false
maintainer: Adrien Berchet (@adrien-berchet)
package_name: dir_content_diff
project_description: Simple tool to compare directory contents.
project_name: Directory Content Difference
project_url: https://dir-content-diff.readthedocs.io
repository_name: dir-content-diff
repository_namespace: BlueBrain
repository_provider: github
setup_codeql: false
ssh_url: git@github.com:BlueBrain/dir-content-diff.git
team_name: ''
tracker_url: https://github.com/BlueBrain/dir-content-diff/issues
use_pyproject_toml: true
version: 1.1.0

# End of Copier answers
6 changes: 6 additions & 0 deletions .copyright.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Copyright (c) 2023-${edit_year} Blue Brain Project, EPFL.

This file is part of dir-content-diff.
See https://github.com/BlueBrain/dir-content-diff for further info.

SPDX-License-Identifier: Apache-2.0
3 changes: 2 additions & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[paths]
sources =
source_paths =
dir_content_diff
*/site-packages/dir_content_diff
*/dir_content_diff/dir_content_diff
*/dir-content-diff/dir_content_diff
11 changes: 11 additions & 0 deletions .coveragerc_min_versions
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[paths]
source_paths =
dir_content_diff
*/site-packages/dir_content_diff
*/dir_content_diff/dir_content_diff
*/dir-content-diff/dir_content_diff

[report]
exclude_also =
return pd\.read_feather\(path, \*\*kwargs\)
data\.to_feather\(path, \*\*kwargs\)
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.asc linguist-detectable=false
.auto-changelog-template.hbs linguist-detectable=false
commitlint.config.js linguist-detectable=false
114 changes: 114 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

name: Create a bug report regarding Directory Content Difference runtime behavior
description: Errors and regression reports with complete reproducing test cases and/or stack traces.
labels: [bug]
title: "[Bug report] "
body:
- type: markdown
attributes:
value: "
Thanks for taking the time to fill out this bug report!
Before submitting, make sure you search in the [issue list](https://github.com/BlueBrain/dir-content-diff/issues) that a similar issue was not already reported.
If it is not the case, please read the following guidelines.
### GUIDELINES FOR REPORTING BUGS
Bug reports that are not properly formulated and formatted or without enough details can be very hard for us to understand and fix.
In order to ensure we can help you fixing your bug, please follow these guidelines.
Your reports must include the following features:
1. **succinct description** of the problem - typically a line or two at most.
2. **succinct, dependency-free code** which reproduces the problem, otherwise known as a [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example.
IF YOU DO NOT HAVE A COMPLETE, RUNNABLE TEST CASE WRITTEN DIRECTLY IN THE TEXTAREA BELOW, YOUR ISSUE MAY BE CLOSED.
3. **complete stack traces for all errors** - please avoid screenshots, use formatted text inside issues.
4. other relevant things as applicable: **dependencies**, **comparative performance timings** for performance issues, etc.
"

- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: input
id: relevant_documentation
attributes:
label: Optional link from https://dir-content-diff.readthedocs.io which documents the behavior that is expected
description: "
Please make sure the behavior you are seeing is definitely in contradiction to what's documented as the correct behavior.
"
validations:
required: false

- type: textarea
attributes:
label: To Reproduce
description: "
Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here."
placeholder: "# Insert code here (text area already python formatted)"
render: Python
validations:
required: true

- type: textarea
attributes:
label: Error
description: "
Provide the complete text of any errors received **including the complete stack trace**.
If the message is a warning, run your program with the ``-Werror`` flag: ``python -Werror myprogram.py``
"
placeholder: "# Copy the complete stack trace and error message here (text area already formatted for Python backtrace)"
render: Python traceback
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false

- type: input
id: package_version
attributes:
label: dir_content_diff Version in Use
description: e.g. 1.4.42, 2.0.2, etc or commit hash
validations:
required: true

- type: input
id: python_version
attributes:
label: Python Version
description: Assumes cpython unless otherwise stated, e.g. 3.10, 3.11, pypy
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating system
description: Check all that apply
multiple: true
options:
- Linux
- MacOS
- Windows
- Other
validations:
required: true

- type: markdown
attributes:
value: "### Thanks! Have a nice day!"
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
Loading