Skip to content

Enable forward slash character in tag pattern of automated github publishing. #8698

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

Merged
merged 1 commit into from
Apr 4, 2025
Merged

Enable forward slash character in tag pattern of automated github publishing. #8698

Show file tree
Hide file tree
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
8 changes: 7 additions & 1 deletion app/lib/package/backend.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,11 @@ final _defaultMaxVersionsPerPackage = 1000;
final Logger _logger = Logger('pub.cloud_repository');
final _validGitHubUserOrRepoRegExp =
RegExp(r'^[a-z0-9\-\._]+$', caseSensitive: false);
// NOTE: The `/` character is allowed inside the tag pattern because we are
// not splitting the `refs/tags/` prefix. A change of that parsing
// should specifically test the presence of `/`.
final _validGitHubVersionPattern =
RegExp(r'^[a-z0-9\-._]+$', caseSensitive: false);
RegExp(r'^[a-z0-9\-._/]+$', caseSensitive: false);
final _validGitHubEnvironment =
RegExp(r'^[a-z0-9\-\._]+$', caseSensitive: false);

Expand Down Expand Up @@ -1759,6 +1762,9 @@ void verifyTagPatternWithRef({
throw AssertionError(
'Configured tag pattern does not include `{{version}}`');
}
// NOTE: The `/` character is allowed inside the tag pattern because we are
// not splitting the `refs/tags/` prefix. A change of this parsing
// should specifically test the presence of `/`.
final expectedRefStart = 'refs/tags/';
if (!ref.startsWith(expectedRefStart)) {
throw AuthorizationException.githubActionIssue(
Expand Down
6 changes: 4 additions & 2 deletions app/test/package/backend_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,8 @@ void main() {
'package-{{version}}',
'package-v{{version}}',
'package-v{{version}}-postfix',
'abc/def-{{version}}',
'{{version}}-abc/def',
];
for (final value in values) {
verifyTagPattern(tagPattern: value);
Expand All @@ -491,8 +493,6 @@ void main() {
'', // empty pattern is not allowed
'{{version}}{{version}}', // two {{version}} is not allowed
'%-{{version}}', // % is not allowed
'abc/def-{{version}}', // / is not allowed
'{{version}}-abc/def', // / is not allowed
];
for (final value in values) {
expect(
Expand All @@ -506,6 +506,7 @@ void main() {
final values = [
('{{version}}', 'refs/tags/1.0.0'),
('pkg-v{{version}}', 'refs/tags/pkg-v1.0.0'),
('dir/pkg-v{{version}}', 'refs/tags/dir/pkg-v1.0.0'),
];
for (final value in values) {
verifyTagPatternWithRef(
Expand All @@ -520,6 +521,7 @@ void main() {
final values = [
('v{{version}}', 'refs/tags/1.0.0'), // does not match `v` prefix
('v{{version}}', 'refs/x/v1.0.0'), // missing refs/tags
('dir/{{version}}', 'refs/tags/v1.0.0'), // missing dir/ prefix
];
for (final value in values) {
expect(
Expand Down