Skip to content

Commit

Permalink
feat: add github specific files
Browse files Browse the repository at this point in the history
  • Loading branch information
Sadhorsephile committed Aug 12, 2024
1 parent 0bf9dfb commit b509f55
Show file tree
Hide file tree
Showing 19 changed files with 601 additions and 4 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Bug report
about: Something is wrong.
title: "[BUG] "
labels: bug
---
<!--
Thank you for contributing to our project!
This template is only for bugfix reports, otherwise please use another template.
-->
## Expected behavior
<!--Tell us what should happen-->

## Actual behavior
<!--Tell us what happens instead-->

## Video/Screenshot
<!--Attach file with a reproduction of bug-->

## Steps to reproduce
<!--
1)...
2)...
3)...
...
-->

## Details

Flutter version: <!--android/ios/web/desktop-->

Dart version: <!--android/ios/web/desktop-->

Platform: <!--android/ios/web/desktop-->

## Logs and stacktrace
<!--
Error details
-->

## Any possible solutions
<!--
Optional
What do you think would solve the problem?
-->

## What did you try to solve
<!--
Optional
What did you try to solve the problem?
-->

## Checklist for self-check

- [ ] Added expected and actual behavior.
- [ ] Added video or screenshot of bug.
- [ ] Added isolated way to reproduce the bug.
- [ ] Specified Flutter, Dart version and platforms.
- [ ] Attached error code and logs.
- [ ] All unspecified fields in the Issue description are deleted.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: SurfGear telegram chat
url: https://t.me/SurfGear
about: Please ask and answer questions here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Documentation update
about: Fixing a problem or improve in an existing docs page.
labels: documentation
---
<!--
Thank you for contributing to our project!
This template is only for documentation update reports, otherwise please use another template.
-->
## Describe what scenario you think is uncovered by the existing examples / articles
<!--A clear and concise description of the problem that you want explained.-->

## Describe why existing examples / articles do not cover this case
<!--Explain which examples / articles you have seen before making this request, and why they did not help you with your problem.-->

## Additional context
<!--Add any other context or screenshots about the documentation request here.-->
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: I'd like SurfGear team to do something new.
labels: enhancement
---
<!--
Thank you for contributing to our project!
This template is only for feature requests, otherwise please use another template.
Provide thoughtful commentary *and code samples* on what this feature means for your product. What will it allow you to do that you can't do today? How will it make current workarounds straightforward? What potential bugs and edge cases does it help to avoid? etc. Please keep it product-centric.
-->
## What is the new or updated feature that you are suggesting?
<!--A clear and concise description of what you want to happen.-->

## Why should this feature be included?
<!--Is your feature request related to a problem? Please describe a clear and concise description of what the problem is. If you investigate any alternative solutions, please describe.-->

## Additional context
<!--Please provide any other context or screenshots about the feature request here.-->
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Tap on "Preview" ⤴

And choose one of the templates:

* [Bugfix PR](?expand=1&template=bug_fix.md)
* [New feature PR](?expand=1&template=new_feature.md)
* [Documentation update PR](?expand=1&template=documentation_update.md)
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
Thank you for contributing to our project!
Provide a description of your changes below and a general summary in the title.
Please look at the following checklist to ensure that your PR can be accepted quickly:
-->
## Checklist

- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
- [ ] Is there an existing issue for this PR?
- _link issue here_ (use keywords like `fix`, `close`, `resolve` etc. if necessary)
- [ ] Have the files been linted and formatted?
- [ ] Have the docs been updated to match the changes in the PR?
- [ ] Have the tests been updated to match the changes in the PR?
- [ ] Attached videos/screenshots demonstrating the fix/feature.
- [ ] Have you run the tests locally to confirm they pass?

## Changes

### What is the current behavior, and the steps to reproduce the issue?

### What is the expected behavior?

### How does this PR fix the problem?
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!--
Thank you for contributing to our project!
Provide a description of your changes below and a general summary in the title.
Please look at the following checklist to ensure that your PR can be accepted quickly:
-->
## Checklist

- [ ] Is there an existing issue for this PR?
- _link issue here_ (use keywords like `fix`, `close`, `resolve` etc. if necessary)
- [ ] Have the files been linted and formatted?

## Changes

### What docs page needs to be fixed?

- **Section**:
- **Page**:

## What is the problem?

## What changes does this PR make to fix the problem?
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!--
Thank you for contributing to our project!
Provide a description of your changes below and a general summary in the title.
Please look at the following checklist to ensure that your PR can be accepted quickly:
-->
## Checklist

- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
- [ ] Is there an existing issue for this PR?
- _link issue here_ (use keywords like `fix`, `close`, `resolve` etc. if necessary)
- [ ] Have the files been linted and formatted?
- [ ] Have the docs been updated to match the changes in the PR?
- [ ] Have the tests been updated to match the changes in the PR?
- [ ] Attached videos/screenshots demonstrating the fix/feature.
- [ ] Have you run the tests locally to confirm they pass?

## New Features

### What new capabilities does this PR add?

### What docs changes are needed to explain this?
24 changes: 24 additions & 0 deletions .github/workflows/on_close_issue_add_comment_to_pyrus_task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Add comment to Pyrus task on issue close

on:
issues:
types:
- closed

jobs:
get_pyrus_task_id:
name: Get Pyrus task ID from special comment in issue
uses: surfstudio/flutter-ci-workflows/.github/workflows/get_pyrus_task_id_from_issue_or_pr_comment.yml@main
with:
ISSUE_NUMBER: ${{ github.event.issue.number }}

add_comment_to_pyrus_task:
name: Add comment to Pyrus task
needs: get_pyrus_task_id
uses: surfstudio/flutter-ci-workflows/.github/workflows/add_comment_to_pyrus_task.yml@main
with:
PYRUS_TASK_ID: ${{ needs.get_pyrus_task_id.outputs.PYRUS_TASK_ID }}
COMMENT_TEXT: The issue is closed.
secrets:
LOGIN: ${{ secrets.PYRUS_BOT_LOGIN }}
SECURITY_KEY: ${{ secrets.PYRUS_BOT_SECRET_KEY }}
24 changes: 24 additions & 0 deletions .github/workflows/on_close_pr_add_comment_to_pyrus_task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Add comment to Pyrus task on PR close

on:
pull_request:
types:
- closed

jobs:
get_pyrus_task_id:
name: Get Pyrus task ID from special comment in issue
uses: surfstudio/flutter-ci-workflows/.github/workflows/get_pyrus_task_id_from_issue_or_pr_comment.yml@main
with:
ISSUE_NUMBER: ${{ github.event.pull_request.number }}

add_comment_to_pyrus_task:
name: Add comment to Pyrus task
needs: get_pyrus_task_id
uses: surfstudio/flutter-ci-workflows/.github/workflows/add_comment_to_pyrus_task.yml@main
with:
PYRUS_TASK_ID: ${{ needs.get_pyrus_task_id.outputs.PYRUS_TASK_ID }}
COMMENT_TEXT: The pull request is closed.
secrets:
LOGIN: ${{ secrets.PYRUS_BOT_LOGIN }}
SECURITY_KEY: ${{ secrets.PYRUS_BOT_SECRET_KEY }}
34 changes: 34 additions & 0 deletions .github/workflows/on_open_issue_create_pyrus_task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Create Pyrus task from new issue

on:
issues:
types:
- opened
- reopened

jobs:
get_package_name:
uses: surfstudio/flutter-ci-workflows/.github/workflows/get_package_name.yml@main

create_pyrus_task:
name: Create Pyrus task from issue
needs: get_package_name
uses: surfstudio/flutter-ci-workflows/.github/workflows/create_pyrus_task_from_issue_or_pr.yml@main
with:
TYPE: Issue
PACKAGE_NAME: ${{ needs.get_package_name.outputs.package_name }}
TITLE: ${{ github.event.issue.title }}
LINK: ${{ github.event.issue.html_url }}
secrets:
LOGIN: ${{ secrets.PYRUS_BOT_LOGIN }}
SECURITY_KEY: ${{ secrets.PYRUS_BOT_SECRET_KEY }}

add_pyrus_task_link:
name: Add Pyrus task link
needs: create_pyrus_task
uses: surfstudio/flutter-ci-workflows/.github/workflows/add_comment_to_issue_or_pr.yml@main
with:
ISSUE_NUMBER: ${{ github.event.issue.number }}
# Don't change the comment link, because the Pyrus task ID is searched by the link text
COMMENT_TEXT: "[Link to Pyrus task](https://pyrus.com/t#id${{ needs.create_pyrus_task.outputs.PYRUS_TASK_ID }})"
REACTIONS: rocket
34 changes: 34 additions & 0 deletions .github/workflows/on_open_pr_create_pyrus_task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Create Pyrus task from new PR

on:
pull_request:
types:
- opened
- reopened

jobs:
get_package_name:
uses: surfstudio/flutter-ci-workflows/.github/workflows/get_package_name.yml@main

create_pyrus_task:
name: Create Pyrus task from pull request
needs: get_package_name
uses: surfstudio/flutter-ci-workflows/.github/workflows/create_pyrus_task_from_issue_or_pr.yml@main
with:
TYPE: Pull request
PACKAGE_NAME: ${{ needs.get_package_name.outputs.package_name }}
TITLE: ${{ github.event.pull_request.title }}
LINK: ${{ github.event.pull_request.html_url }}
secrets:
LOGIN: ${{ secrets.PYRUS_BOT_LOGIN }}
SECURITY_KEY: ${{ secrets.PYRUS_BOT_SECRET_KEY }}

add_pyrus_task_link:
name: Add Pyrus task link
needs: create_pyrus_task
uses: surfstudio/flutter-ci-workflows/.github/workflows/add_comment_to_issue_or_pr.yml@main
with:
ISSUE_NUMBER: ${{ github.event.pull_request.number }}
# Don't change the comment link, because the Pyrus task ID is searched by the link text
COMMENT_TEXT: "[Link to Pyrus task](https://pyrus.com/t#id${{ needs.create_pyrus_task.outputs.PYRUS_TASK_ID }})"
REACTIONS: rocket
35 changes: 35 additions & 0 deletions .github/workflows/on_pull_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: On pull request

on:
pull_request:

jobs:
get_flutter_version:
uses: surfstudio/flutter-ci-workflows/.github/workflows/get_flutter_version.yml@main

analysis:
needs: get_flutter_version
uses: surfstudio/flutter-ci-workflows/.github/workflows/analysis.yml@main
with:
FLUTTER_VERSION: ${{ needs.get_flutter_version.outputs.FLUTTER_VERSION }}

testing:
needs: [analysis, get_flutter_version]
uses: surfstudio/flutter-ci-workflows/.github/workflows/testing.yml@main
with:
FLUTTER_VERSION: ${{ needs.get_flutter_version.outputs.FLUTTER_VERSION }}
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

build_android_example:
needs: [analysis, get_flutter_version]
uses: surfstudio/flutter-ci-workflows/.github/workflows/build_android_example.yml@main
with:
FLUTTER_VERSION: ${{ needs.get_flutter_version.outputs.FLUTTER_VERSION }}
JAVA_VERSION: 17

build_ios_example:
needs: [analysis, get_flutter_version]
uses: surfstudio/flutter-ci-workflows/.github/workflows/build_ios_example.yml@main
with:
FLUTTER_VERSION: ${{ needs.get_flutter_version.outputs.FLUTTER_VERSION }}
35 changes: 35 additions & 0 deletions .github/workflows/publish_to_pub.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Publishing

on:
push:
tags:
- v*

jobs:
get_flutter_version:
uses: surfstudio/flutter-ci-workflows/.github/workflows/get_flutter_version.yml@main

analysis:
needs: get_flutter_version
uses: surfstudio/flutter-ci-workflows/.github/workflows/analysis.yml@main
with:
FLUTTER_VERSION: ${{ needs.get_flutter_version.outputs.FLUTTER_VERSION }}

testing:
needs: [analysis, get_flutter_version]
uses: surfstudio/flutter-ci-workflows/.github/workflows/testing.yml@main
with:
FLUTTER_VERSION: ${{ needs.get_flutter_version.outputs.FLUTTER_VERSION }}
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

package-publishing:
needs: [analysis, testing, get_flutter_version]
uses: surfstudio/flutter-ci-workflows/.github/workflows/publish_to_pub.yml@main
with:
FLUTTER_VERSION: ${{ needs.get_flutter_version.outputs.FLUTTER_VERSION }}
PANA_TOTAL: "100"
secrets:
PUB_CREDENTIAL_JSON: ${{ secrets.SURF_PUB_CREDENTIAL_JSON }}
PUB_OAUTH_ACCESS_TOKEN: ${{ secrets.SURF_PUB_OAUTH_ACCESS_TOKEN }}
PUB_OAUTH_REFRESH_TOKEN: ${{ secrets.SURF_PUB_OAUTH_REFRESH_TOKEN }}
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 0.0.1
## 0.0.1-alpha

* TODO: Describe initial release.
* Initial release
Loading

0 comments on commit b509f55

Please sign in to comment.