Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
Update all repo-level links
  • Loading branch information
stuartmorgan-g committed May 24, 2024
commit 5869d706e0a463373ef8fe2d6ef646fdfe9958ad
2 changes: 1 addition & 1 deletion .ci/targets/analyze_legacy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ tasks:
# This is to minimize accidentally making changes that break old versions
# (which we don't commit to supporting, but don't want to actively break)
# without updating the constraints.
# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#supported-flutter-versions
# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#supported-flutter-versions
- name: analyze - legacy
script: .ci/scripts/analyze_legacy.sh
21 changes: 9 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@

*List which issues are fixed by this PR. You must list at least one issue.*

*If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].*

## Pre-launch Checklist

- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
- [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities.
- [ ] I read the [Tree Hygiene] page, which explains my responsibilities.
- [ ] I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use `dart format`.)
- [ ] I signed the [CLA].
- [ ] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]`
- [ ] I [linked to at least one issue that this PR fixes] in the description above.
- [ ] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes].
- [ ] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style].
- [ ] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style], or this PR is [exempt from CHANGELOG changes].
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is [test-exempt].
- [ ] All existing and new tests are passing.
Expand All @@ -22,14 +20,13 @@ If you need help, consider asking for advice on the #hackers-new channel on [Dis

<!-- Links -->
[Contributor Guide]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md
[Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene
[Tree Hygiene]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md
[relevant style guides]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md#style
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes
[Discord]: https://github.com/flutter/flutter/wiki/Chat
[linked to at least one issue that this PR fixes]: https://github.com/flutter/flutter/wiki/Tree-hygiene#overview
[Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md
[linked to at least one issue that this PR fixes]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#overview
[pub versioning philosophy]: https://dart.dev/tools/pub/versioning
[exempt from version changes]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#version-and-changelog-updates
[following repository CHANGELOG style]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changelog-style
[test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests
[exempt from version changes]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#version
[following repository CHANGELOG style]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog-style
[exempt from CHANGELOG changes]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog
[test-exempt]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#tests
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ guide](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md).

Additional resources specific to the packages repository:
- [Setting up the Packages development
environment](https://github.com/flutter/flutter/wiki/Setting-up-the-Packages-development-environment),
environment](https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/Setting-up-the-Packages-development-environment.md),
which covers the setup process for this repository.
- [Packages repository structure](https://github.com/flutter/flutter/wiki/Plugins-and-Packages-repository-structure),
- [Packages repository structure](https://github.com/flutter/flutter/blob/master/docs/ecosystem/Plugins-and-Packages-repository-structure.md),
to get an overview of how this repository is laid out.
- [Contributing to Plugins and Packages](https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages),
- [Contributing to Plugins and Packages](https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md),
for more information about how to make PRs for this repository, especially when
changing federated plugins.
- [Plugin tests](https://github.com/flutter/flutter/wiki/Plugin-Tests), which explains
the different kinds of tests used for plugins, where to find them, and how to run them.
- [Plugin tests](https://github.com/flutter/flutter/blob/master/docs/ecosystem/testing/Plugin-Tests.md),
which explains the different kinds of tests used for plugins, where to find them, and how to run them.
As explained in the Flutter guide,
[**PRs need tests**](https://github.com/flutter/flutter/wiki/Tree-hygiene#tests), so
[**PRs need tests**](https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#tests), so
this is critical to read before submitting a plugin PR.

### Code review processes and automation
Expand All @@ -24,14 +24,14 @@ PRs will automatically be assigned to
[code owners](https://github.com/flutter/packages/blob/main/CODEOWNERS)
for review.
If a code owner is creating a PR, they should explicitly pick another
[Flutter team member](https://github.com/flutter/flutter/wiki/Contributor-access)
[Flutter team member](https://github.com/flutter/flutter/blob/master/docs/contributing/Contributor-access.md)
as a code reviewer.

### Style

Flutter packages and plugins follow Google style—or Flutter style for Dart—for the languages they
use, and use auto-formatters:
- [Dart](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo) formatted
- [Dart](https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md) formatted
with `dart format`
- [C++](https://google.github.io/styleguide/cppguide.html) formatted with `clang-format`
- **Note**: The Linux plugins generally follow idiomatic GObject-based C
Expand All @@ -50,4 +50,4 @@ use, and use auto-formatters:

If you are a team member landing a PR, or just want to know what the release
process is for package changes, see [the release
documentation](https://github.com/flutter/flutter/wiki/Releasing-a-Plugin-or-Package).
documentation](https://github.com/flutter/flutter/blob/master/docs/ecosystem/release/README.md).
4 changes: 2 additions & 2 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ linter:
# - prefer_constructors_over_static_methods # far too many false positives
- prefer_contains
# - prefer_double_quotes # opposite of prefer_single_quotes
# - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods
# - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#consider-using--for-short-functions-and-methods
- prefer_final_fields
- prefer_final_in_for_each
- prefer_final_locals
Expand All @@ -160,7 +160,7 @@ linter:
- prefer_if_null_operators
- prefer_initializing_formals
- prefer_inlined_adds
# - prefer_int_literals # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#use-double-literals-for-double-constants
# - prefer_int_literals # conflicts with https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#use-double-literals-for-double-constants
- prefer_interpolation_to_compose_strings
- prefer_is_empty
- prefer_is_not_empty
Expand Down
2 changes: 1 addition & 1 deletion script/configs/allowed_pinned_deps.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# The list of external dependencies that are allowed as pinned dependencies.
# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#Dependencies
# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#Dependencies
#
# All entries here should have an explanation for why they are here.

Expand Down
2 changes: 1 addition & 1 deletion script/configs/allowed_unpinned_deps.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# The list of external dependencies that are allowed as unpinned dependencies.
# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#Dependencies
# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#Dependencies
#
# All entries here should have an explanation for why they are here, either
# via being part of one of the default-allowed groups, or a specific reason.
Expand Down
8 changes: 4 additions & 4 deletions script/tool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ dart run script/tool/bin/flutter_plugin_tools.dart update-excerpts
dart run script/tool/bin/flutter_plugin_tools.dart update-excerpts --packages package_name
```

_See also: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#readme-code_
_See also: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#readme-code_

### Update CHANGELOG and Version

Expand Down Expand Up @@ -153,9 +153,9 @@ generation (e.g., regenerating mocks when updating `mockito`).
**Releases are automated for `flutter/packages`.**

The manual procedure described here is _deprecated_, and should only be used when
the automated process fails. Please, read
[Releasing a Plugin or Package](https://github.com/flutter/flutter/wiki/Releasing-a-Plugin-or-Package)
on the Flutter Wiki first.
the automated process fails. Please read
[Releasing a Plugin or Package](https://github.com/flutter/flutter/blob/master/docs/ecosystem/release/README.md)
before using `publish`.

```sh
cd <path_to_repo>
Expand Down
6 changes: 3 additions & 3 deletions script/tool/lib/src/gradle_check_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ class GradleCheckCommand extends PackageLoopingCommand {
/// Documentation url for Artifact hub implementation in flutter repo's.
@visibleForTesting
static const String artifactHubDocumentationString =
r'https://github.com/flutter/flutter/wiki/Plugins-and-Packages-repository-structure#gradle-structure';
r'https://github.com/flutter/flutter/blob/master/docs/ecosystem/Plugins-and-Packages-repository-structure.md#gradle-structure';

/// String printed as example of valid example root build.gradle repository
/// configuration that enables artifact hub env variable.
Expand All @@ -158,7 +158,7 @@ class GradleCheckCommand extends PackageLoopingCommand {
final RegExp keyPresentRegex =
RegExp('$keyVariable' r"\s+=\s+'ARTIFACT_HUB_REPOSITORY'");
final RegExp documentationPresentRegex = RegExp(
r'github\.com.*wiki.*Plugins-and-Packages-repository-structure.*gradle-structure');
r'github\.com.*flutter.*blob.*Plugins-and-Packages-repository-structure.*gradle-structure');
final RegExp keyReadRegex =
RegExp(r'if.*System\.getenv.*\.containsKey.*' '$keyVariable');
final RegExp keyUsedRegex =
Expand Down Expand Up @@ -223,7 +223,7 @@ apply plugin: "com.google.cloud.artifactregistry.gradle-plugin"
bool _validateArtifactHubSettingsUsage(
RepositoryPackage example, List<String> gradleLines) {
final RegExp documentationPresentRegex = RegExp(
r'github\.com.*wiki.*Plugins-and-Packages-repository-structure.*gradle-structure');
r'github\.com.*flutter.*blob.*Plugins-and-Packages-repository-structure.*gradle-structure');
final RegExp artifactRegistryDefinitionRegex = RegExp(
r'classpath.*gradle\.plugin\.com\.google\.cloud\.artifactregistry:artifactregistry-gradle-plugin');
final RegExp artifactRegistryPluginApplyRegex = RegExp(
Expand Down
2 changes: 1 addition & 1 deletion script/tool/lib/src/make_deps_path_based_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class MakeDepsPathBasedCommand extends PackageCommand {
// the federated plugin change process don't think it's a mistake.
static const String _dependencyOverrideWarningComment =
'# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.\n'
'# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changing-federated-plugins';
'# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins';

@override
final String name = 'make-deps-path-based';
Expand Down
2 changes: 1 addition & 1 deletion script/tool/lib/src/native_test_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const String misconfiguredJavaIntegrationTestErrorExplanation =
'The following files use @RunWith(FlutterTestRunner.class) '
'but not @DartIntegrationTest, which will cause hangs when run with '
'this command. See '
'https://github.com/flutter/flutter/wiki/Plugin-Tests#enabling-android-ui-tests '
'https://github.com/flutter/flutter/blob/master/docs/ecosystem/testing/Plugin-Tests.md#enabling-android-ui-tests '
'for instructions.';

/// The command to run native tests for plugins:
Expand Down
2 changes: 1 addition & 1 deletion script/tool/lib/src/pubspec_check_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ class PubspecCheckCommand extends PackageLoopingCommand {
'''
The following unexpected non-local dependencies were found:
${badDependencies.map((String name) => ' $name').join('\n')}
Please see https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#Dependencies
Please see https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#Dependencies
for more information and next steps.
''',
if (misplacedDevDependencies.isNotEmpty)
Expand Down
6 changes: 3 additions & 3 deletions script/tool/lib/src/readme_check_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import 'common/output_utils.dart';
import 'common/package_looping_command.dart';
import 'common/repository_package.dart';

const String _instructionWikiUrl =
'https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages';
const String _instructionUrl =
'https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md';

/// A command to enforce README conventions across the repository.
class ReadmeCheckCommand extends PackageLoopingCommand {
Expand Down Expand Up @@ -180,7 +180,7 @@ class ReadmeCheckCommand extends PackageLoopingCommand {
printError(
'\n${indentation}For each block listed above, add <?code-excerpt ...> '
'tag on the previous line, as explained at\n'
'$_instructionWikiUrl');
'$_instructionUrl');
errorSummary ??= 'Missing code-excerpt management for code block';
}

Expand Down
2 changes: 1 addition & 1 deletion script/tool/lib/src/update_excerpts_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ class UpdateExcerptsCommand extends PackageLoopingCommand {
'the resulting changes.\n'
'\n'
'${indentation}For more information, see '
'https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#readme-code',
'https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#readme-code',
);
return PackageResult.fail();
}
Expand Down
2 changes: 1 addition & 1 deletion script/tool/lib/src/version_check_command.dart
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ ${indentation}HTTP response: ${pubVersionFinderResponse.httpResponse.body}
'${indentation}Breaking changes to platform interfaces are not '
'allowed without explicit justification.\n'
'${indentation}See '
'https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages '
'https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md '
'for more information.');
return _CurrentVersionState.invalidChange;
}
Expand Down
2 changes: 1 addition & 1 deletion script/tool/test/make_deps_path_based_command_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ ${devDependencies.map((String dep) => ' $dep: $constraint').join('\n')}
packageA.pubspecFile.readAsLinesSync(),
containsAllInOrder(<String>[
'# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.',
'# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changing-federated-plugins',
'# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins',
'dependency_overrides:',
]));
});
Expand Down
6 changes: 3 additions & 3 deletions script/tool/test/pubspec_check_command_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1613,7 +1613,7 @@ ${_topicsSection()}
contains(
' The following unexpected non-local dependencies were found:\n'
' bad_dependency\n'
' Please see https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#Dependencies\n'
' Please see https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#Dependencies\n'
' for more information and next steps.'),
]),
);
Expand Down Expand Up @@ -1645,7 +1645,7 @@ ${_topicsSection()}
contains(
' The following unexpected non-local dependencies were found:\n'
' bad_dependency\n'
' Please see https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#Dependencies\n'
' Please see https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#Dependencies\n'
' for more information and next steps.'),
]),
);
Expand Down Expand Up @@ -1729,7 +1729,7 @@ ${_topicsSection()}
contains(
' The following unexpected non-local dependencies were found:\n'
' allow_pinned\n'
' Please see https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#Dependencies\n'
' Please see https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#Dependencies\n'
' for more information and next steps.'),
]),
);
Expand Down
2 changes: 1 addition & 1 deletion script/tool/test/readme_check_command_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -697,7 +697,7 @@ A B C
contains('Dart code block at line 3 is not managed by code-excerpt.'),
// Ensure that the failure message links to instructions.
contains(
'https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages'),
'https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md'),
contains('Missing code-excerpt management for code block'),
]),
);
Expand Down
2 changes: 1 addition & 1 deletion script/tool/test/version_check_command_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ void main() {
contains(
' Breaking changes to platform interfaces are not allowed '
'without explicit justification.\n'
' See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages '
' See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md '
'for more information.'),
]));
expect(
Expand Down