Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support 'consider_paths' or alike to trigger update ONLY if changes to those paths happened this year #626

Open
yarikoptic opened this issue Feb 11, 2025 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@yarikoptic
Copy link

Is your feature request related to a problem? Please describe.

I do like to have the projects I am involved in to display the range of years for the copyright statement as it gives users/visitors immediate feedback on longevity and project being alive. So I was very happy to find this project -- thanks! It was also great to see that README which outlined solutions for so many desires ;)

But unconditionally updating year in a copyright statement whenever there is no copyrightable changes were done that year might be considered "not kosher", and also misrepresent project, so I would prefer to avoid that. I thought to, following the example in readme just make it happen on the first push to master. But that still might be not exactly "right", e.g. could be due to some dependabot boosted versions etc.

Describe the solution you'd like

I think such a problem could be largely addressed by adding rather simplistic check on either current git history warrants update of the copyright year. I potentially envision following settings to add to tune to the liking to pretty much consider git log --no-merges --since 01/01/$(date +%Y) output

  • minimal_commits_number, defaulting to 0 to mimic current default behavior that it would trigger updates regardless of commits present in that year. But someone might say, I need at least 1 or 10 commits...
  • exclude_authors, if specified would be a regex to exclude commits from those authors
  • consider_paths, if specified, would be a list of paths to give to that git log invocation to limit to only those paths

Obviously the last two should either change default of minimal_commits_number to 1 or higher to be of effect.

@yarikoptic yarikoptic added the enhancement New feature or request label Feb 11, 2025
Copy link
Contributor

Hi there and welcome to this repository!

A maintainer will be with you shortly, but first and foremost I would like to thank you for taking the time to report this issue. Quality is of the highest priority for us, and we would never release anything with known defects. We aim to do our best but unfortunately you are here because you encountered something we didn't expect. Lets see if we can figure out what went wrong and provide a remedy for it.

@yarikoptic yarikoptic changed the title Support 'filter-path' or alike to trigger update ONLY if changes to those paths happened this year Support 'consider_paths' or alike to trigger update ONLY if changes to those paths happened this year Feb 11, 2025
yarikoptic added a commit to dandi/dandi-cli that referenced this issue Feb 11, 2025
Ideally we should restrict it to only "useful" changes, e.g. under
dandi/ folder. Filed

- FantasticFiasco/action-update-license-year#626
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants