DEV/material-components_material-components-ios

mirror of https://github.com/material-components/material-components-ios.git synced 2026-02-20 08:27:32 +08:00

History

[scripts/release] Ignore goldens when generating component notes (#6861 )

Prior to this change, `./scripts/release notes` would consider commits that affected our snapshot goldens (found in `snapshot_test_goldens` as multi-component changes.

After this change, snapshot tests that change our goldens are properly bucketed in the relevant component.

## Before

```
## Changes

### ActionSheet

* [Fixes broken action sheet tests. (#6743)](fbcf524161) (Robert Moore)

### BottomNavigation

* [Clean up internal constants (#6834)](585a5f4d30) (Robert Moore)
* [Examples clean-up. (#6718)](10ed6188a5) (Robert Moore)
* [Prevents the client from setting the navigation items directly when using the bottom navigation bar controller. (#6773)](d049bc882a) (Eric Lee)

### Buttons

* [Allow setting `accessibilityTraits`. (#6766)](66c46649db) (Robert Moore)

### Collections

* [Clean up interface by removing NS_REQUIRES_SUPER (#6788)](921ad6e4db) (dmaclach)

### Ripple

* [Added a fix for the ripple sometimes blinking when ending animation (#6792)](6f51d265ad) (Yarden Eitan)
* [update docs (#6772)](c2e912df8f) (Yarden Eitan)

### Snackbar

* [Make initialization threadsafe. (#6768)](530c7b9b61) (Robert Moore)

### Tabs

* [Fix badge text truncation bug in MDCItemBarCell (#6786)](188f05a75e) (Andrew Overton)

## Multi-component changes

* [Add basic Snapshot tests (#6826)](2e5df058e3) (Robert Moore)
* [Add basic Snapshot tests. (#6801)](dd363f1118) (Robert Moore)
* [Add basic Snapshot tests. (#6821)](b1cab54a4f) (Robert Moore)
* [Add basic Snapshot tests. (#6823)](1d058b155b) (Robert Moore)
* [Add basic Snapshot tests. (#6824)](951cc57ba0) (Robert Moore)
* [Add basic Snapshot tests. (#6825)](018e72e3cf) (Robert Moore)
* [Add basic Snapshot tests. (#6828)](32904609b0) (Robert Moore)
* [Add basic snapshot tests. (#6822)](9e8fdc2d7f) (Robert Moore)
* [Dynamic Type 2.0 (#6733)](648f2499e8) (ianegordon)
* [Enable -Wunguarded-availability. (#6776)](f17b01c584) (featherless)
* [Revert "[Typography] Dynamic Type 2.0 (#6733)" (#6848)](7f52f35f07) (ianegordon)
* [{Tests} Fix font comparison in Objective-C. (#6789)](3447c7b719) (Robert Moore)
```

## After

```
## Changes

### ActionSheet

* [Fixes broken action sheet tests. (#6743)](fbcf524161) (Robert Moore)

### ActivityIndicator

* [Add basic Snapshot tests (#6826)](2e5df058e3) (Robert Moore)

### BottomNavigation

* [Clean up internal constants (#6834)](585a5f4d30) (Robert Moore)
* [Examples clean-up. (#6718)](10ed6188a5) (Robert Moore)
* [Prevents the client from setting the navigation items directly when using the bottom navigation bar controller. (#6773)](d049bc882a) (Eric Lee)

### Buttons

* [Allow setting `accessibilityTraits`. (#6766)](66c46649db) (Robert Moore)

### Collections

* [Clean up interface by removing NS_REQUIRES_SUPER (#6788)](921ad6e4db) (dmaclach)

### List

* [Add basic snapshot tests. (#6822)](9e8fdc2d7f) (Robert Moore)

### NavigationBar

* [Add basic Snapshot tests. (#6821)](b1cab54a4f) (Robert Moore)

### PageControl

* [Add basic Snapshot tests. (#6823)](1d058b155b) (Robert Moore)

### ProgressView

* [Add basic Snapshot tests. (#6825)](018e72e3cf) (Robert Moore)

### Ripple

* [Added a fix for the ripple sometimes blinking when ending animation (#6792)](6f51d265ad) (Yarden Eitan)
* [update docs (#6772)](c2e912df8f) (Yarden Eitan)

### Snackbar

* [Add basic Snapshot tests. (#6824)](951cc57ba0) (Robert Moore)
* [Make initialization threadsafe. (#6768)](530c7b9b61) (Robert Moore)

### Tabs

* [Add basic Snapshot tests. (#6801)](dd363f1118) (Robert Moore)
* [Fix badge text truncation bug in MDCItemBarCell (#6786)](188f05a75e) (Andrew Overton)

### Typography

* [Add basic Snapshot tests. (#6828)](32904609b0) (Robert Moore)

## Multi-component changes

* [Dynamic Type 2.0 (#6733)](648f2499e8) (ianegordon)
* [Enable -Wunguarded-availability. (#6776)](f17b01c584) (featherless)
* [Revert "[Typography] Dynamic Type 2.0 (#6733)" (#6848)](7f52f35f07) (ianegordon)
* [{Tests} Fix font comparison in Objective-C. (#6789)](3447c7b719) (Robert Moore)
```

2019-03-13 09:55:46 -04:00

check

Added a script to check that umbrella header are used between components (#2241 )

2017-10-25 18:50:56 -04:00

external

[kokoro] Extract more of the clang-format logic out to clang-format-ci. (#5722 )

2018-11-19 22:09:50 -05:00

generated

[Catalog] One more icon needed for the menu in our catalog (#3492 )

2018-04-25 15:43:18 -04:00

install

[scripts] Add git-clang-format to the clang-format installer. (#4831 )

2018-08-20 10:15:48 -04:00

lib

{kokoro} Only upgrade gem/homebrew when needed. (#6261 )

2019-01-11 10:14:45 -05:00

templates/component

No longer using -init for Color Scheme. (#5734 )

2018-11-12 12:54:47 -05:00

xcode

Remove references to scripts/release/ paths.

2017-12-11 13:45:18 -05:00

affected_targets

{kokoro} Fix affected targets calculation. (#6185 )

2019-01-07 10:42:32 -05:00

apply_all_templates

added shape theming to the scripting generation (#5463 )

2018-10-19 16:32:33 -04:00

apply_template

[scripts] Implement a templatized readme generator. (#3601 )

2018-05-01 14:24:29 -04:00

build_all

[Scripts] Optionally use xcpretty in scripts/build_all. (#1571 )

2017-06-26 13:57:42 -04:00

build_codelabs

[Codelabs] Update build tests for codelabs (#4871 )

2018-08-22 17:34:15 -04:00

build_site.sh

[kokoro] Add website generator command (#3541 )

2018-04-27 09:28:20 -04:00

check_components

[Scripts] Add readme metadata config check (#1775 )

2017-08-11 10:02:19 -04:00

clean_all

Remove references to scripts/release/ paths.

2017-12-11 13:45:18 -05:00

convert_name

Renamed scripts/naming_convention to convert_name. (#1026 )

2016-12-13 19:38:53 -05:00

export-patch

Migrate Material Motion's release toolchain to MDC (#2627 )

2017-12-11 10:17:48 -05:00

files_missing_bazel_target

[Scripts] bazel coverage ignores deletions. (#6431 )

2019-01-22 09:28:20 -05:00

format_all

[Swiftlint] Moar swiftlint fixes (#1155 )

2017-01-25 17:23:20 -05:00

gendocs.sh

Adding AUTHORS and removing CONTRIBUTORS.txt.

2016-08-08 08:16:37 -07:00

generate_all_readmes

[Docs] Add badges to all components. (#4278 )

2018-05-25 11:12:48 -04:00

generate_jazzy_yamls.sh

updated jazzy yaml files to include framework root (#6750 )

2019-03-01 16:52:02 -05:00

generate_readme

[scripts/generate_readme] Add .jazzy.yaml check. (#4938 )

2018-08-29 09:25:35 -04:00

install_contributor_tools

Added script to install SwiftLint. (#1143 )

2017-01-06 13:56:46 -05:00

lint_all

[Scripts] Only lint catalog, components, and demos (#1744 )

2017-08-07 12:27:10 -04:00

list_components

[Scripts] Add readme metadata config check (#1775 )

2017-08-11 10:02:19 -04:00

manage_pods.py

Migrate Material Motion's release toolchain to MDC (#2627 )

2017-12-11 10:17:48 -05:00

prep_all

Remove references to scripts/release/ paths.

2017-12-11 13:45:18 -05:00

print_version

Move source of truth for version numbers outside of Cocoapods (#2442 )

2017-11-16 07:52:36 -05:00

readme_to_console

Migrate Material Motion's release toolchain to MDC (#2627 )

2017-12-11 10:17:48 -05:00

README-release.md

Update release tool instructions to use command release notes (#3075 )

2018-03-09 16:59:30 -05:00

README.md

[Codelabs] Add documentation for build_codelabs script (#4952 )

2018-09-11 07:49:43 -07:00

release

[scripts/release] Ignore goldens when generating component notes (#6861 )

2019-03-13 09:55:46 -04:00

sync_icons.sh

[Collections] Use image cache for selection icons (#1638 )

2017-07-14 16:50:39 -04:00

temporary_clone_at_ref

Migrate Material Motion's release toolchain to MDC (#2627 )

2017-12-11 10:17:48 -05:00

test_all

Snapshot Testing Proof of Concept (#5887 )

2018-12-05 09:49:41 -05:00

versionignore

Reduce error output from the bump command. (#2754 )

2017-12-22 11:02:11 -05:00

README.md

Scripts

Scripts for maintaining Material Components for iOS—none of these scripts are required to use MDC or for casual contributors.

The important scripts are:

prep_all: prepare the Material Components catalog, tests, and demos apps for building.
build_all: build the Material Components catalog and each of our demo apps.
test_all: build and test the Material Components unit and integration tests.
clean_all: remove artifacts from the prep_all, build_all, and test_all scripts.
check_components: run component checks for documentation, examples, etc.
install_contributor_tools: install local contributor tools to speed up the development cycle.

Languages

Material Components follows Google's language standards for scripting. The following languages can be used for scripts:

Either language can be used for a particular purpose, but larger or more complex scripts should be written in (or converted to) Python. Bash scripts get unwieldy quickly and advanced Bash scripting knowledge is currently less common than advanced Python scripting knowledge.

The intent is that the scripts will run on relatively current OS X machines with (only) Xcode installed.

iOS Codelabs Build Tests

iOS codelabs build tests ensure that the Objective C and Swift versions of Codelab 104 Complete and Codelab 111 Complete can be built. If a release fails the codelabs build tests, follow these steps:

If the release changes a component that the codelabs use, submit a PR to the codelabs repo with the appropriate changes for the adjusted component. Address each codelab and language that is affected by the change (it may be helpful to run ./build_codelabs -a to determine which codelabs are affected).
Merge the PR into the codelabs repo, and then rerun the codelabs build tests.
Continue with the release process.