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

Normalise inputs names #56

Closed
vlaurin opened this issue Oct 21, 2022 · 0 comments · Fixed by #61
Closed

Normalise inputs names #56

vlaurin opened this issue Oct 21, 2022 · 0 comments · Fixed by #61
Labels
priority:high type:chore Not pretty but needs to be done
Milestone

Comments

@vlaurin
Copy link
Owner

vlaurin commented Oct 21, 2022

Inputs related to inclusion or exclusion of versions should be normalised to follow the naming convention:

  • prune- prefix: include versions for pruning
  • keep- prefix: exclude versions from pruning

This builds on the pattern initially used by keep-last and later by keep-tags and keep-tags-regexes and will help streamline adoption/usage by offering a new way of documenting usage.

If possible, all keep- inputs should always take precedence over the prune- inputs as this is the less destructive approach (ie. better to prune less than too much).

Backward compatibility

Existing inputs affected by this which do not currently follow the convention (older-than, untagged and tag-regex) will be flagged as deprecated and preserved for the foreseeable future (as a minimum until v1.0.0, possibly more) so as to offer a transition period for consumers.

@vlaurin vlaurin added type:chore Not pretty but needs to be done priority:high labels Oct 21, 2022
@vlaurin vlaurin added this to the 0.5.0 milestone Oct 21, 2022
vlaurin added a commit that referenced this issue Jan 7, 2023
Resolves #56
Resolves #10

With that change, all filters either start with `keep-` (exclusion) or `prune-` (inclusion).
This contributes to making usage of the action more comprehensible and less error prone.
Non-normalised inputs are preserved for backward compatibility until v2 and/or a minimum of one year.

This change also adds support for multiple regexes via new input `prune-tags-regexes` replacing `tag-regex`.
vlaurin added a commit that referenced this issue Jan 7, 2023
Resolves #56
Resolves #10

With that change, all filters either start with `keep-` (exclusion) or `prune-` (inclusion).
This contributes to making usage of the action more comprehensible and less error prone.
Non-normalised inputs are preserved for backward compatibility until v2 and/or a minimum of one year.

This change also adds support for multiple regexes via new input `prune-tags-regexes` replacing `tag-regex`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority:high type:chore Not pretty but needs to be done
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant