Skip to content

Commit 4b2b81e

Browse files
authored
[api_summary] Prepare for v1.0.0 release and fix AOT SDK discovery (#2599)
1 parent 65c5dba commit 4b2b81e

4 files changed

Lines changed: 11 additions & 18 deletions

File tree

‎pkgs/api_summary/CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
## 0.1.0-wip
1+
## 1.0.0
22

3-
- First release.
3+
- Initial stable release.

‎pkgs/api_summary/README.md‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ containing a `pubspec.yaml` file.
1818

1919
### Installing Globally
2020

21-
Activate the package using `dart pub global`:
21+
Install the executable using `dart install`:
2222

2323
```bash
24-
dart pub global activate api_summary
24+
dart install api_summary
2525
```
2626

2727
Then run the tool:
@@ -62,7 +62,7 @@ Add `api_summary` to your `pubspec.yaml`:
6262

6363
```yaml
6464
dependencies:
65-
api_summary: ^0.1.0-wip
65+
api_summary: ^1.0.0
6666
```
6767
6868
### Basic Example
@@ -160,15 +160,3 @@ void main() {
160160
});
161161
}
162162
```
163-
164-
## Status: experimental
165-
166-
**NOTE**: This package is currently experimental and published under the
167-
[tools.dart.dev](https://dart.dev/dart-team-packages) pub publisher in order to
168-
solicit feedback.
169-
170-
These packages have a much higher expected rate of API and breaking changes.
171-
172-
Your feedback is valuable and will help us evolve this package. For general
173-
feedback, suggestions, and comments, please file an issue in the
174-
[bug tracker](https://github.com/dart-lang/tools/issues).

‎pkgs/api_summary/lib/api_summary.dart‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import 'dart:io';
66

77
import 'package:analyzer/dart/analysis/analysis_context_collection.dart';
88
import 'package:analyzer/file_system/physical_file_system.dart';
9+
import 'package:cli_util/cli_util.dart' show sdkPath;
910
import 'package:path/path.dart' as p;
1011
import 'package:yaml/yaml.dart';
1112

@@ -45,6 +46,7 @@ Future<ApiSummary> apiSummary(
4546
final collection = AnalysisContextCollection(
4647
resourceProvider: provider,
4748
includedPaths: [libPath],
49+
sdkPath: sdkPath,
4850
);
4951
final context = collection.contextFor(libPath);
5052
return buildApiPackage(

‎pkgs/api_summary/pubspec.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
name: api_summary
2-
version: 0.1.0-wip
2+
version: 1.0.0
33
description: Creates an API summary for a package.
4+
repository: https://github.com/dart-lang/tools/tree/main/pkgs/api_summary
5+
issue_tracker: https://github.com/dart-lang/tools/issues?q=is%3Aissue+is%3Aopen+label%3Apackage%3Aapi_summary
46

57
environment:
68
sdk: ^3.12.0
79

810
dependencies:
911
analyzer: '>=13.0.0 <15.0.0'
1012
args: ^2.6.0
13+
cli_util: ^0.6.0
1114
collection: ^1.19.0
1215
path: ^1.9.0
1316
yaml: ^3.1.2

0 commit comments

Comments
 (0)