Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners

* @zgosalvez
11 changes: 11 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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`)
14 changes: 14 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ Create workflows in your `.github/workflows` directory. Examples are available i

*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).

### 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

### 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.
Expand All @@ -32,6 +42,10 @@ Also known as CDelivery (not to be mistaken with another CD, i.e., Continuous De

*Note:* Since CDelivery reruns the `testing` job from CI, it will cost you additional runner minutes. If you are conscious of your budget and [require branches to be up to date before merging](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/enabling-required-status-checks#:~:text=Require%20branches%20to%20be%20up%20to%20date%20before%20merging), you should comment the job out.

[`.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](https://github.com/zgosalvez/github-actions-flutter-workflow/workflows/Deployment/badge.svg)](https://github.com/zgosalvez/github-actions-flutter-workflow/actions?query=workflow%3ADeployment)

Expand Down
2 changes: 2 additions & 0 deletions .github/pr-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
enhancement: feature/*
bug: hotfix/*
21 changes: 21 additions & 0 deletions .github/workflows/pull_request-opened.yml
Original file line number Diff line number Diff line change
@@ -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 }}