Release v1.0.0+14 (#12)

zgosalvez · web-flow · commit 92bb897fe80b · 2021-01-03T19:36:53.000+08:00
* Fixes release notes with GitHub flow (#10) * Adds PR actions (#11) * Adds Protected Branches * Adds PR actions * Update README.md * Update README.md (#13) * Optimize CD (#14)
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,3 @@
+# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+*    @zgosalvez
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+# Contributing
+
+## Welcome
+Thank you for contributing to this repository! :bow:
+
+## Process
+1. Create a branch with the following [supported](pr-labeler.yml) prefixes:
+  - `feature/` (i.e., enhancements)
+  - `hotfix/` (i.e., bug fixes)
+2. Make changes
+3. Create a PR to the appropriate branch (`release/v*`/`main`)
diff --git a/.github/README.md b/.github/README.md
@@ -1,37 +1,55 @@
 # GitHub Actions: Flutter Workflows
 
-This sample project allows you to leverage GitHub Actions to run common Flutter workflows. These are based on the workflows found in the [Flutter Gallery](https://github.com/flutter/gallery) repository.
+This sample project allows you to leverage GitHub Actions to run common Flutter workflows. These are based on the workflows found in the [Flutter Gallery](https://github.com/flutter/gallery) repository. Continue reading to apply these to your Flutter project.
+
+## Disclaimer
+This is still in active development, and it currently supports iOS and Android deployments only. Please open a pull request to support other platforms.
 
 ## Usage
 
-Create a workflow `.yml` file in your `.github/workflows` directory. Example workflows are available in this repository. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
+Create workflows in your `.github/workflows` directory. Examples are available in this repository. For more information, see the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
+
+*Note:* Although this Flutter project works as-is, consider tailoring these workflows to your needs. If you're starting from scratch, copying and pasting will work as long as you follow the [GitHub flow](https://guides.github.com/introduction/flow/) and [release based workflow](https://lab.github.com/githubtraining/create-a-release-based-workflow).
 
-## Workflows
+### Protected Branches
+Recommended rules for the `main` and `release/v*` branches:
+- [x] Require status checks to pass before merging
+  - [x] Require branches to be up to date before merging
+  - [x] Check security hardening
+  - [x] Generate coverage report
+  - [x] Run static testing
+  - [x] Run unit testing
+  - [x] Run widget testing
 
-All workflows use the [Ensure SHA Pinned Actions](https://github.com/marketplace/actions/ensure-sha-pinned-actions) action to ensure security hardening.
+### Workflows
 
-_Note:_ The [Get the Flutter Version Environment](https://github.com/marketplace/actions/get-the-flutter-version-environment) action requires that the [`pubspec.yaml`](pubspec.yaml) file contains an `environment:flutter:` key. This is used for installing Flutter in the workflows.
+- All of the workflows here use the [Ensure SHA Pinned Actions](https://github.com/marketplace/actions/ensure-sha-pinned-actions) action to ensure security hardening.
+- The [Get the Flutter Version Environment](https://github.com/marketplace/actions/get-the-flutter-version-environment) action requires that the [`pubspec.yaml`](pubspec.yaml) file contains an `environment:flutter:` key, which is used for installing Flutter with the correct version.
 
-### Continuous Integration
+#### Continuous Integration
 [![CI](https://github.com/zgosalvez/github-actions-flutter-workflow/workflows/CI/badge.svg)](https://github.com/zgosalvez/github-actions-flutter-workflow/actions?query=workflow%3ACI)
 
 [`.github/workflows/ci.yml`](workflows/ci.yml)
 
-Also known as CI, Continuous Integration runs Flutter static and dynamic tests on every pull request to `main`, then the coverage report is stored as an artifact for reference. Modify the workflow to further process the code coverage file using [code quality](https://github.com/marketplace?type=actions) or [code review](https://github.com/marketplace?category=code-review&type=actions) actions.
+Also known as CI, Continuous Integration runs Flutter static and dynamic tests on *every pull request* to `main` and `release/v*`, then the coverage report is stored as an artifact for reference. A comment is added to the pull request on every run as seen here, [#10 (comment)](https://github.com/zgosalvez/github-actions-flutter-workflows/pull/10#issuecomment-753592566). Modify the workflow to further process the code coverage file using [code quality](https://github.com/marketplace?type=actions) or [code review](https://github.com/marketplace?category=code-review&type=actions) actions.
 
-### Continuous Delivery
+#### Continuous Delivery
 [![CDelivery](https://github.com/zgosalvez/github-actions-flutter-workflow/workflows/CDelivery/badge.svg)](https://github.com/zgosalvez/github-actions-flutter-workflow/actions?query=workflow%3ACDelivery)
 
 [`.github/workflows/cdelivery.yml`](workflows/cdelivery.yml)
 
-Also known as CDelivery (not to be mistaken with another CD, Continuous Deployment), Continuous Delivery reruns the same Flutter static and dynamic tests from the CI on every push to `main`, then a pre-release draft is created. Manually, remove the pre-release mark after it has been deployed and released to the app store.
+Also known as CDelivery (not to be mistaken with another CD, i.e., Continuous Deployment), Continuous Delivery drafts a pre-release on *every push* to `main` and `release/v*`. This ensures that the drafted release is created or updated. Manually remove the pre-release mark after it has been deployed and released to the app store.
+
+[`.github/workflows/pull_request-opened.yml`](workflows/pull_request-opened.yml)
+
+To draft the release this workflow uses the [Release Drafter](https://github.com/marketplace/actions/release-drafter) action to compile the pull requests and categorizes it using the [PR Labeler](https://github.com/marketplace/actions/pr-labeler) action. Add the [`.github/release-drafter.yml`](release-drafter.yml) and [`.github/pr-labeler.yml`](pr-labeler.yml) files in your project since these are required configurations for these actions, respectively. Customize the configuration files as needed.
 
-### Deployment
+#### Deployment
 [![Deployment](https://github.com/zgosalvez/github-actions-flutter-workflow/workflows/Deployment/badge.svg)](https://github.com/zgosalvez/github-actions-flutter-workflow/actions?query=workflow%3ADeployment)
 
 [`.github/workflows/deployment.yml`](workflows/deployment.yml)
 
-Deployment is triggered when the release draft is published. It reruns the same Flutter static and dynamic tests from the CI before running Flutter's build commands. The app version used is based on the release tag, not the name. Lastly, build artifacts are uploaded as release assets.
+Deployment is triggered when the release draft (or any release) is published. It reruns the same Flutter static and dynamic tests from the CI before running Flutter's build commands. The app version used is based on the release tag, not the name. Lastly, build artifacts are uploaded as release assets.
 
 ## License
 The scripts and documentation in this project are released under the [MIT License](LICENSE)
diff --git a/.github/pr-labeler.yml b/.github/pr-labeler.yml
@@ -0,0 +1,2 @@
+enhancement: feature/*
+bug: hotfix/*
diff --git a/.github/workflows/cdelivery.yml b/.github/workflows/cdelivery.yml
@@ -2,7 +2,9 @@ name: CDelivery
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
+      - release/v*
 
 jobs:
   security_hardening:
@@ -14,73 +16,9 @@ jobs:
     - name: Ensure SHA pinned actions
       uses: zgosalvez/github-actions-ensure-sha-pinned-actions@e70e07ef05f0a3bf1483fde3c50eeab9c1805041 # v1.0.1
 
-  testing:
-    name: Run ${{ matrix.category }} testing
-    needs: security_hardening
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        category: [static, unit, widget]
-      fail-fast: false
-    steps:
-    - name: Clone the repository
-      uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
-      with:
-        path: code
-    - name: Get Flutter version
-      id: get-flutter-version
-      uses: zgosalvez/github-actions-get-flutter-version-env@2106839043b63948638cf22ee33718862fdcc57d # v1.1.2
-      with:
-        pubspec-file-path: code/pubspec.yaml
-    - name: Cache Flutter
-      id: flutter-cache
-      uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a # v2.1.3
-      with:
-        path: flutter
-        key: ${{ env.cache-name }}-ubuntu-latest-${{ steps.get-flutter-version.outputs.version }}-${{ hashFiles('code/pubspec.lock') }}
-        restore-keys: |
-          ${{ env.cache-name }}-ubuntu-latest-${{ steps.get-flutter-version.outputs.version }}-
-          ${{ env.cache-name }}-ubuntu-latest-
-          ${{ env.cache-name }}-
-      env:
-        cache-name: flutter-cache
-    - name: Clone the Flutter repository
-      if: steps.flutter-cache.outputs.cache-hit != 'true'
-      uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
-      with:
-        repository: flutter/flutter
-        ref: ${{ steps.get-flutter-version.outputs.version }}
-        path: flutter
-    - name: Add the flutter tool to the path
-      run: |
-        echo "$GITHUB_WORKSPACE/flutter/bin" >> $GITHUB_PATH
-        echo "$GITHUB_WORKSPACE/flutter/bin/cache/dart-sdk/bin" >> $GITHUB_PATH
-    - name: Populate the Flutter tool's cache of binary artifacts
-      if: steps.flutter-cache.outputs.cache-hit != 'true'
-      run: |
-        flutter config --no-analytics
-        flutter precache
-    - name: Get Flutter packages
-      run: flutter pub get
-      working-directory: code
-
-    # static testing
-    - name: Analyze Flutter
-      if: matrix.category == 'static'
-      uses: zgosalvez/github-actions-analyze-flutter@f5a4e9edfc655081eb438cf5901f1d48c9e5d281 # v1.3.2
-      with:
-        fail-on-warnings: true
-        working-directory: code
-    
-    # unit testing
-    - name: Run Flutter ${{ matrix.category }} tests
-      if: matrix.category != 'static'
-      run: flutter test --no-pub test/${{ matrix.category }}s
-      working-directory: code
-
   draft_release:
     name: Draft a release
-    needs: testing
+    needs: security_hardening
     runs-on: ubuntu-latest
     steps:
     - name: Clone the repository
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,7 +2,9 @@ name: CI
 
 on:
   pull_request:
-    branches: [ main ]
+    branches:
+      - main
+      - release/v*
 
 jobs:
   security_hardening:
diff --git a/.github/workflows/pull_request-opened.yml b/.github/workflows/pull_request-opened.yml
@@ -0,0 +1,21 @@
+name: Pull Request (Opened)
+
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  assign_author:
+    name: Assign Author to the Pull Request
+    runs-on: ubuntu-latest
+    steps:
+    - name: Assign Author to the Pull Request
+      uses: technote-space/assign-author@6252488282b99652aef47451a353eb88aea24666 # v1.5.7
+
+  pr-labeler:
+    name: Label the PR based on the branch
+    runs-on: ubuntu-latest
+    steps:
+    - uses: TimonVS/pr-labeler-action@bd0b592a410983316a454e3d48444608f028ec8e # v3.1.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners`
	`2`	`+`
	`3`	`+* @zgosalvez`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+enhancement: feature/*`
	`2`	`+bug: hotfix/*`