From 793e8a4e836b2b63b5f28d5f245fe49b3e2d3148 Mon Sep 17 00:00:00 2001 From: Luke Walton Date: Fri, 25 Oct 2024 21:00:15 +0100 Subject: [PATCH] chore(main): release 1.1.0 (#9) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit :robot: I have created a release *beep* *boop* --- ## [1.1.0](https://github.com/ZebraDevs/zds-android/compare/1.0.0...v1.1.0) (2024-10-25) ### ✨ New Features * Add positive button variant ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) * Updating font to IBM Plex Sans ([bd9e361](https://github.com/ZebraDevs/zds-android/commit/bd9e36102f864d9bdda95c58ae572df7c9ac4716)) * Updating font to IBM Plex Sans ([5c3cfc3](https://github.com/ZebraDevs/zds-android/commit/5c3cfc3846794b457a84325c5a528cb9e7e6e1b7)) ### 🪲 Bug Fixes * Updated colours to match Zeta ([#5](https://github.com/ZebraDevs/zds-android/issues/5)) ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) ### 📈 Documentation * Update button docs ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) * Update readme, fix broken links, update icons docs ([445100e](https://github.com/ZebraDevs/zds-android/commit/445100e9ad9f4a6a63f16f14a5f053bb73bbf1ac)) ### ⛓️ Dependencies * **automated:** Update icons ([#8](https://github.com/ZebraDevs/zds-android/issues/8)) ([990ec23](https://github.com/ZebraDevs/zds-android/commit/990ec23854d3a9f2f95b072df6e5a0848030d875)) * **automated:** Update icons 2024-10-18 ([60249ed](https://github.com/ZebraDevs/zds-android/commit/60249edf1090257f78e8bae50fbdd011a988aeba)) * **automated:** Update icons 2024-10-18 ([00aeae9](https://github.com/ZebraDevs/zds-android/commit/00aeae93ce5acb61acf2127f2615ab40f6be91da)) * Update gradle, android compileSdk 34 and other dependencies ([#6](https://github.com/ZebraDevs/zds-android/issues/6)) ([445100e](https://github.com/ZebraDevs/zds-android/commit/445100e9ad9f4a6a63f16f14a5f053bb73bbf1ac)) ### 🧹 Miscellaneous Chores * Add version to example app ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) * Organise / clean code using Android studio built in tools ([445100e](https://github.com/ZebraDevs/zds-android/commit/445100e9ad9f4a6a63f16f14a5f053bb73bbf1ac)) * Remove unnecessary icons from example app ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --- .github/workflows/on-release.yml | 4 +-- .release-please-manifest.json | 2 +- CHANGELOG.md | 36 +++++++++++++++++++ README.md | 34 ++++++++++++------ .../java/com/zebra/zdsDemo/MainActivity.java | 2 +- components/build.gradle | 6 ++-- components/proguard-rules.pro | 1 + 7 files changed, 67 insertions(+), 18 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.github/workflows/on-release.yml b/.github/workflows/on-release.yml index 55ca102..8171304 100644 --- a/.github/workflows/on-release.yml +++ b/.github/workflows/on-release.yml @@ -24,8 +24,8 @@ jobs: uses: gradle/actions/setup-gradle@v4 - name: Add environment variables run: | - echo "artifactoryusername=${{secrets.ARTIFACTORY_USERNAME}}" >> gradle.properties - echo "artifactorypassword=${{secrets.ARTIFACTORY_PASSWORD}}" >> gradle.properties + echo "mavenUsername=${{secrets.ARTIFACTORY_USERNAME}}" >> gradle.properties + echo "mavenPassword=${{secrets.ARTIFACTORY_PASSWORD}}" >> gradle.properties echo "zds-android-maven=${{secrets.ZDS_ANDROID_MAVEN}}" >> gradle.properties - name: Publish diff --git a/.release-please-manifest.json b/.release-please-manifest.json index fea3454..2601677 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.0.0" + ".": "1.1.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5cd9de9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,36 @@ +# Changelog + +## [1.1.0](https://github.com/ZebraDevs/zds-android/compare/1.0.0...v1.1.0) (2024-10-25) + + +### ✨ New Features + +* Add positive button variant ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) +* Updating font to IBM Plex Sans ([bd9e361](https://github.com/ZebraDevs/zds-android/commit/bd9e36102f864d9bdda95c58ae572df7c9ac4716)) +* Updating font to IBM Plex Sans ([5c3cfc3](https://github.com/ZebraDevs/zds-android/commit/5c3cfc3846794b457a84325c5a528cb9e7e6e1b7)) + + +### 🪲 Bug Fixes + +* Updated colours to match Zeta ([#5](https://github.com/ZebraDevs/zds-android/issues/5)) ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) + + +### 📈 Documentation + +* Update button docs ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) +* Update readme, fix broken links, update icons docs ([445100e](https://github.com/ZebraDevs/zds-android/commit/445100e9ad9f4a6a63f16f14a5f053bb73bbf1ac)) + + +### ⛓️ Dependencies + +* **automated:** Update icons ([#8](https://github.com/ZebraDevs/zds-android/issues/8)) ([990ec23](https://github.com/ZebraDevs/zds-android/commit/990ec23854d3a9f2f95b072df6e5a0848030d875)) +* **automated:** Update icons 2024-10-18 ([60249ed](https://github.com/ZebraDevs/zds-android/commit/60249edf1090257f78e8bae50fbdd011a988aeba)) +* **automated:** Update icons 2024-10-18 ([00aeae9](https://github.com/ZebraDevs/zds-android/commit/00aeae93ce5acb61acf2127f2615ab40f6be91da)) +* Update gradle, android compileSdk 34 and other dependencies ([#6](https://github.com/ZebraDevs/zds-android/issues/6)) ([445100e](https://github.com/ZebraDevs/zds-android/commit/445100e9ad9f4a6a63f16f14a5f053bb73bbf1ac)) + + +### 🧹 Miscellaneous Chores + +* Add version to example app ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) +* Organise / clean code using Android studio built in tools ([445100e](https://github.com/ZebraDevs/zds-android/commit/445100e9ad9f4a6a63f16f14a5f053bb73bbf1ac)) +* Remove unnecessary icons from example app ([4e05e08](https://github.com/ZebraDevs/zds-android/commit/4e05e086135cf9cd557903bcf68265ce1dc75893)) diff --git a/README.md b/README.md index 66fd52d..fb6b4c9 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ Once logged in with SSO, select your username in the top right corner, and selec These credentials will need to be passed into Gradle, but they should not be committed to source control. It is recommended for individuals to save their username and password in their global `gradle.properties` file in the `/.gradle` directory (This file may need to be created). The following format is only an example, and any names can be given. ```gradle - artifactusername=XXX - artifactpassword=YYY + mavenUsername=XXX + mavenPassword=YYY ``` These credentials should **_never_** be shared. @@ -38,8 +38,8 @@ dependencyResolutionManagement { maven{ url "https://artifactory-us.zebra.com/artifactory/dmo-mvn-rel/" credentials { - username = "${artifactusername}" - password = "${artifactpassword}" + username = "${mavenUsername}" + password = "${mavenPassword}" } } } @@ -64,8 +64,8 @@ dependencyResolutionManagement { maven{ url = uri("https://artifactory-us.zebra.com/artifactory/dmo-mvn-rel/") credentials { - username = getProperty("artifactoryusername") - password = getProperty("artifactorypassword") + username = getProperty("mavenUsername") + password = getProperty("mavenPassword") } } } @@ -74,7 +74,11 @@ dependencyResolutionManagement { -### 4. Add dependency to app build file +### 4. Run gradle build + +This step is needed to ensure that gradle can sync and pull data from the maven repository. In Android studio, click the 'Make Module' button in the toolbar (hammer icon). + +### 5. Add dependency to app build file This file should be located within the app directory of your project (not the root level); below are examples for both `build.gradle` and `build.gradle.kts` @@ -85,7 +89,7 @@ This file should be located within the app directory of your project (not the ro ``` dependencies { ... - implementation 'com.zebra:zds:1.0.0' + implementation 'com.zebra:zds:1.1.0' } ``` @@ -96,6 +100,15 @@ dependencies { +dependencies { +... +implementation("com.zebra:zds:1.1.0") +} + + + +Once you have done this, and performed a sync and build, the IDE _should_ recommend this line be refactored into the new style below: + ``` dependencies { ... @@ -103,10 +116,9 @@ dependencies { } ``` - -### 5. Add theme to manifest +### 6. Add theme to manifest For the components to work and receive the correct theme values, we must add the theme in `AndroidManifest.xml`. Be sure to remove other themes which could override this and prevent the components from working. @@ -118,7 +130,7 @@ For the components to work and receive the correct theme values, we must add the /> ``` -### 6. Use components +### 7. Use components ```xml