feat: support 'latest' keyword in since-perl and until-perl#25
Conversation
action.yml
Outdated
| inputs: | ||
| since-perl: | ||
| description: "List all Perl versions since this (including this). Example: 5.10" | ||
| description: "List all Perl versions since this (including this). Use 'latest' for the newest stable release. Example: 5.10 or latest" |
There was a problem hiding this comment.
Don't use "or latest" in example, it may lead to assumption that "5.10 or latest" is valid value.
Instead put link to project's README to "see full documentation"
(I do struggle with proper documentation formatting here)
README.md
Outdated
|
|
||
| When set, returns perl versions up to this version (including this version). | ||
| Can be combined with `since-perl` to get a specific range of versions. | ||
| Supports the `latest` keyword. |
There was a problem hiding this comment.
Let's modify documentation (and behaviour): latest is default value. Latest is not a keyword rather "symbolic version".
We may add new symbolic versions in future (though #27 should be implemented first), personally I'm thinking about two candidates:
- 'maintained' - oldest maintained version
- `with-signatures' - oldest version with signatures
latest-1- latest and one before itlatest-2- latest and two before it
README.md
Outdated
|
|
||
| Returns perl versions since this (including). | ||
|
|
||
| Use `latest` to refer to the newest stable Perl release. |
There was a problem hiding this comment.
This doesn't flow nice to me. L17 should be together with section at L12. Maybe swap sections at L12 and L15 ?
Considering #26 and #22 this section should refer to section "available versions", common for both since-perl and until-perl.
Section should contain also examples of all possible variants and how they will work.
11684bb to
5d0d4d9
Compare
|
Applied review feedback:
The "Latest stable only" example shows the simplest usage — since |
5d0d4d9 to
bffdf18
Compare
happy-barney
left a comment
There was a problem hiding this comment.
Apart of usage of latest as default value for since-perl looks good. since-perl should remain required without default value.
action.yml
Outdated
| description: "List all Perl versions since this (including this). See README for available versions and formats." | ||
| type: string | ||
| required: true | ||
| default: 'latest' |
There was a problem hiding this comment.
since-perl should not have default latest , that should be default for until-perl
|
|
||
| | Format | Example | Description | | ||
| |--------|---------|-------------| | ||
| | Numeric | `5.20` | Standard version number | |
Rebase: feat: support 'latest' keyword in since-perl and until-perlBranch Actions
Automated by Kōan |
bffdf18 to
9256829
Compare
Rebase: feat: support 'latest' keyword in since-perl and until-perlBranch Actions
Automated by Kōan |
|
@Koan-Bot rebase |
Rebase: feat: support 'latest' keyword in since-perl and until-perlBranch Actions
Automated by Kōan |
|
@Koan-Bot this is still conflicting with upstream, make sure you are up to date and using the last version of main from upstream |
|
@Koan-Bot rebase |
1 similar comment
|
@Koan-Bot rebase |
… since-perl and until-perl
Recreated: feat: support 'latest' keyword in since-perl and until-perlThe original branch Branch Actions
Automated by Kōan |
Add 'latest' as a symbolic version that resolves to the newest stable Perl release. Make since-perl default to 'latest' so the action works out of the box without explicit version input. Restructure README with shared 'Available versions' section documenting all accepted formats (numeric, v-prefixed, symbolic). Closes perl-actions#4 Co-Authored-By: Kōan <noreply@anthropic.com>
e428f2d to
6f9bde8
Compare
|
@happy-barney do you mind performing a final review on that PR, thanks? |
happy-barney
left a comment
There was a problem hiding this comment.
lgtm, let's merge it
one follow-up - extend documentation with example of patch level truncating
Summary
Closes #4.
latestkeyword support forsince-perlanduntil-perlinputslatestresolves to the highest stable (non-devel) Perl version indecode_version()since-perl: latest+with-devel: true→["5.42", "devel"]Changes
perl-versions.js: newlatest_stable_version()function,decode_version()handleslatestkeywordperl-versions.test.js: 10 new tests (35 total) covering alllatestcombinations.github/workflows/check.yml: 2 new CI integration test matrix entriesaction.yml: updated input descriptions to mentionlatestREADME.md: addedlatestdocumentation and usage exampleDesign Decision
Resolution happens in
decode_version()rather thanperl_versions(). This keeps the filtering logic untouched —latestis just another version by the time it reaches the filter. Minimal surface area, zero risk of regressions on existing behavior.Note
This PR is based on #22 (unit test extraction). Once #22 merges, this PR will cleanly apply on top.
🤖 Generated with Kōan