Skip to content
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.

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

[native_assets_cli] [doc] Document multiple invocation behavior #1891

Merged
merged 2 commits into from
Jan 15, 2025

Conversation

dcharkes
Copy link
Collaborator

@dcharkes dcharkes commented Jan 14, 2025

Document the behavior of multiple invocations of hooks.

Closes: #1739

We could keep buildAssetTypes as a list of strings for now. We might want to make link hooks work with multiple asset types later as a non-breaking change.

Both Dart and Flutter only pass [CodeAsset.type], so they are already satisfying that every asset type has its own invocation.

Copy link

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbols
License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/jni/lib/src/third_party/generated_bindings.dart
pkgs/objective_c/lib/src/ns_input_stream.dart

@coveralls
Copy link

coveralls commented Jan 14, 2025

Coverage Status

coverage: 87.412% (+0.01%) from 87.4%
when pulling da7f8eb on multiple-invocations-documentation
into f179ec2 on main.

/// they are invoked for an asset type that is not emitted by the hook:
///
/// ```dart
/// if (input.config.buildAsstTypes.contains('some_asset_type')) {
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can drop this part and only have the one below?

@auto-submit auto-submit bot merged commit 3bbd95e into main Jan 15, 2025
40 checks passed
@auto-submit auto-submit bot deleted the multiple-invocations-documentation branch January 15, 2025 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[native_assets_cli] Semantics of one vs multiple hook invocations
3 participants