Skip to content

Commit

Permalink
chore(SNP-903): Fix and update CI, add new templates, update FVM (#80)
Browse files Browse the repository at this point in the history
* chore(SNP-903): fix check issue workflow path

* chore(SNP-903): add issues to Pyrus task workflow

* chore(SNP-903): update GitHub Action workflows

* chore(SNP-903): add new PR and issues templates

* chore(SNP-903): FVM update

* chore(SNP-903): update gitignore

* chore(SNP-903): update GitHub Action workflows

* chore: chore
  • Loading branch information
martynov-alex authored Mar 4, 2024
1 parent 4a646c6 commit c87eed4
Show file tree
Hide file tree
Showing 18 changed files with 125 additions and 161 deletions.
4 changes: 0 additions & 4 deletions .fvm/fvm_config.json

This file was deleted.

3 changes: 3 additions & 0 deletions .fvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"flutter": "3.7.6"
}
67 changes: 40 additions & 27 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,58 @@
---
name: Bug report
about: Something is wrong with Flutter OTP Autofill.
about: Something is wrong.
title: "[BUG] "
labels: bug
assignees: MbIXjkee
---

<!--
Thank you for contributing to our project!
This template is only for bug reports, otherwise please use another template.
The best bug report is a failing test in the repository as a pull request.
Run `flutter analyze` if there are any analysis errors, try resolving them before filing this issue.
This template is only for bugfix reports, otherwise please use another template.
-->
## Expected behavior
<!--Tell us what should happen-->

## Prior Issues

Are there any existing issues or PRs that relate to this problem? If so, link them here.

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

A clear and concise description of what the bug is.
Please show the code you wrote as completely as possible.
## Video/Screenshot
<!--Attach file with a reproduction of bug-->

```dart
/// your code here
```
## Steps to reproduce
<!--
1)...
2)...
3)...
...
-->

## Steps to Reproduce
## Details
Flutter version: <!--android/ios/web/desktop-->

If the current behavior is a bug, please provide the steps to reproduce.
Dart version: <!--android/ios/web/desktop-->

## What is the expected behavior?
Platform: <!--android/ios/web/desktop-->

A clear and concise description of what you expected to happen.
## Logs and stacktrace
<!--
Error details
-->

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

* What package and OS are affected by this issue? Did this work in previous versions of a package?

* If applicable, add screenshots to help explain your problem.
## What did you try to solve
<!--
Optional
What did you try to solve the problem?
-->

* Please provide output from `flutter doctor -v` and `flutter analyze`.

* Add any other context about the problem here.
## 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.
14 changes: 5 additions & 9 deletions .github/ISSUE_TEMPLATE/documentation_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,19 @@
name: Documentation update
about: Fixing a problem or improve in an existing docs page.
labels: documentation
assignees: MbIXjkee
---

<!--
Thank you for contributing to our project!
This template is only for documentation update reports, otherwise please use another template.
-->
## Specify package name
<!--Write the name of the package where you have problems-->

## Describe what scenario you think is uncovered by the existing examples / articles

A clear and concise description of the problem that you want explained.
<!--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.
<!--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.
<!--Add any other context or screenshots about the documentation request here.-->
20 changes: 9 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
---
name: Feature Request
about: I'd like Flutter OTP Autofill to do something new.
name: Feature request
about: I'd like SurfGear team to do something new.
labels: enhancement
assignees: MbIXjkee
---

<!--
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 work-arounds straightforward? What potential bugs and edge cases does it help to avoid? etc. Please keep it product-centric.
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.
-->
## Specify package name
<!--Write the name of the package where you have problems-->

## What is the new or updated feature that you are suggesting?

A clear and concise description of what you want to happen.
<!--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 investigated any alternative solutions please describe.
<!--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.
<!--Please provide any other context or screenshots about the feature request here.-->
74 changes: 5 additions & 69 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,6 @@
## Related tasks
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#related-tasks
-->
Tap on "Preview" ⤴


## Dependence on other Pull Requests (optional)
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#dependence-on-other-pull-requests-optional
-->

## Background (optional)
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#background-optional
-->

## Changes
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#changes
-->

## Troubles (optional)
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#troubles-optional
-->

## Note (optional)
<!--
For more info https://github.com/surfstudio/flutter-roadmap/blob/main/docs/PULL_REQUEST_TEMPLATE_README.md#note-optional
-->

## Checklist for self-check
- [ ] Commits and PRs have been filed according to [the rules on the project](https://github.com/surfstudio/surf-flutter-app-template#workflow-in-a-repository).
- [ ] The author is marked as an assigne and assigned mandatory reviewers.
- [ ] Required labels marked
- [ ] Specified related tasks and/or related PRs.
- [ ] Specified Changes.
- [ ] Attached videos/screenshots demonstrating the fix/feature.
- [ ] All unspecified fields in the PR description deleted.
- [ ] New code covered by tests.

## Checklist for reviewers
- [ ] CI passed successfully _(with a green check mark)_.
- [ ] PR is atomic, by volume no more than 400 (+-) corrected lines (not including codogen).

Design:
- [ ] System design corresponds to the agreements on structure and architecture on the project.
- [ ] The code is decomposed into necessary and sufficient components.

Functionality:
- [ ] The code solves the problem.
- [ ] Any changes to the user interface are reasonable and look good.

Complexity:
- [ ] The code is clear, easy to read, functions are small, no more than 50 lines.
- [ ] The logic is not overcomplicated, there is no overengineering (no code sections that may be needed in the future, but no one knows about it).

Tests:
- [ ] Updated or added tests for mandatory components.
- [ ] The tests are correct, helpful, and well designed/developed.

Naming:
- [ ] The naming of variables, methods, classes and other components is understandable.

Comments:
- [ ] The comments are understandable and helpful.

Documentation:
- [ ] All labels are correct
- [ ] Technical documentation updated (after approval, updates last reviewer).
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)
10 changes: 2 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
---
name: Bug fix
about: Fixing a problem with Flutter OTP Autofill.
assignees: MbIXjkee
---

<!--
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_
- _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
Expand Down
10 changes: 1 addition & 9 deletions .github/PULL_REQUEST_TEMPLATE/documentation_update.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
---
name: Documentation update
about: Fixing a problem or improve in an existing docs page.
labels: documentation
assignees: MbIXjkee
---

<!--
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_
- _link issue here_ (use keywords like `fix`, `close`, `resolve` etc. if necessary)
- [ ] Have the files been linted and formatted?

## Changes
Expand Down
10 changes: 2 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE/new_feature.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
---
name: New feature
labels: enhancement
assignees: MbIXjkee
---

<!--
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_
- _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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check_issue.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:

jobs:
check-issue:
uses: surfstudio/flutter-ci-workflows/.github/workflows/сheck_issues.yaml@main
uses: surfstudio/flutter-ci-workflows/.github/workflows/check_issues.yaml@main
with:
REPO_PATH: 'https://github.com/surfstudio/flutter-otp-autofill/issues/new/choose'
ISSUE_TITLE: ${{ github.event.issue.title }}
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
name: "Main"

on:
pull_request
pull_request:

jobs:
get_fvm_version:
outputs:
flutter_version: ${{ steps.fvm_version.outputs.flutterSdkVersion }}
flutter_version: ${{ steps.fvm_version.outputs.flutter }}
name: "Get Flutter version from FVM"
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- id: fvm_version
uses: zoexx/github-action-json-file-properties@release
with:
file_path: ".fvm/fvm_config.json"
file_path: ".fvmrc"

analysis:
needs: get_fvm_version
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/new_issue_to_pyrus_task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: "Create Pyrus task from issue"

on:
issues:
types:
- reopened
- opened

jobs:
get_package_name:
name: Get package name
runs-on: ubuntu-latest
outputs:
package_name: ${{ steps.parse_pubspec.outputs.name }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Parsing pubspec.yaml
id: parse_pubspec
uses: actions-tools/yaml-outputs@v2
with:
file-path: 'pubspec.yaml'

call_create_pyrus_task_from_issue:
name: Create Pyrus task from issue
needs: get_package_name
uses: surfstudio/flutter-ci-workflows/.github/workflows/new_issue_to_pyrus_task.yml@main
with:
PACKAGE_NAME: ${{ needs.get_package_name.outputs.package_name }}
ISSUE_TITLE: ${{ github.event.issue.title }}
ISSUE_BODY: ${{ github.event.issue.body }}
ISSUE_LINK: ${{ github.event.issue.html_url }}
secrets:
LOGIN: ${{ secrets.PYRUS_BOT_LOGIN }}
SECURITY_KEY: ${{ secrets.PYRUS_BOT_SECRET_KEY }}
2 changes: 1 addition & 1 deletion .github/workflows/new_issues_label.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ jobs:
label_issues:
uses: surfstudio/flutter-ci-workflows/.github/workflows/new_issues_label.yml@main
secrets:
SECRET_ISSUES: ${{ secrets.SECRET_ISSUES }}
SECRET_ISSUES: ${{ secrets.ACCESS_TOKEN_FOR_SURFGEAR }}
Loading

0 comments on commit c87eed4

Please sign in to comment.