docs: clarify allowlist entry limits - #162
Open
sylvesterkaczmarek wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarify that Fence has different 64-entry counting semantics for the native multiline Action input and the advanced JSON configuration.
Problem
The public docs currently say an allowlist may contain 64 unique entries and that duplicates count only once, then describe the advanced JSON
configinput as having the same 64-entry limit.That is accurate for the native multiline input, which normalizes and deduplicates before enforcing its unique-entry limit. The advanced JSON path intentionally rejects an
allowlistarray with more than 64 physical entries before normalization, so duplicate JSON entries still consume the limit.Evidence / reproduction
action/lib.cts, the native multiline parser canonicalizes each allowance, tracks it in aSet, and enforces the limit only when a new unique canonical entry would be added. Repeated or equivalent native lines therefore do not consume additional slots.parsed.allowlist.length <= 64. That check is on the physical array length, before allowance normalization/deduplication.action/test.ctscoverage reflects both contracts: the native-input tests verify canonical duplicates count once, while the raw JSON configuration test verifies a 65-element array is rejected.allowlist; it normalizes to one entry. Put the same allowance object 65 times in advanced JSONconfig; validation rejects the array for exceeding 64 entries.docs/allowlist.mdsays duplicates count only once and immediately notes that advanced JSON also has a 64-entry limit, which naturally implies the same counting semantics even though the implementation and tests say otherwise.This PR changes only the documentation so each public input describes the limit it already enforces.
Change
Documentation only; no input-validation or policy behavior changes.