Skip to content

document 'keep' better #362

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

document 'keep' better #362

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion gateway/gateway.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class RefDetails(TypedDict):

Attributes:
expires_at: After this date the reference will be removed
keep: Optional flag to retain the reference regardless of expiry
keep: Optional flag to retain the reference, regardless of expiry, and not start the clock on expiry when new tags appear
Copy link
Member

@snazy snazy Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean that keep: true is inherited for action-version-bumps?

Copy link
Member

@snazy snazy Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably worth to mention that expires_at and keep are mutually exclusive (with #363).

Copy link
Member Author

@raboof raboof Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean that keep: true is inherited for action-version-bumps?

No

Probably worth to mention that expires_at and keep are mutually exclusive

Well, they're not, in that case keep takes precedence. It might make sense to clean that up and make them mutually exclusive, but that's not something I plan to take on right now.

"""

expires_at: date
Expand Down