-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 99e8f66
Showing
29 changed files
with
1,760 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
version: 2 | ||
enable-beta-ecosystems: true | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" | ||
- package-ecosystem: "pub" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
name: releascribe_cli | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- ".github/workflows/releascribe_cli.yaml" | ||
- "lib/**" | ||
- "test/**" | ||
- "pubspec.yaml" | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- ".github/workflows/releascribe_cli.yaml" | ||
- "lib/**" | ||
- "test/**" | ||
- "pubspec.yaml" | ||
|
||
jobs: | ||
|
||
build: | ||
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1 | ||
|
||
verify-version: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: 📚 Git Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: 🎯 Setup Dart | ||
uses: dart-lang/setup-dart@v1 | ||
with: | ||
sdk: "stable" | ||
|
||
- name: 📦 Install Dependencies | ||
run: | | ||
dart pub get | ||
- name: 🔎 Verify version | ||
run: dart run test --run-skipped -t version-verify |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# See https://www.dartlang.org/guides/libraries/private-files | ||
|
||
# Files and directories created by pub | ||
.dart_tool/ | ||
.packages | ||
build/ | ||
pubspec.lock | ||
|
||
# Files generated during tests | ||
.test_coverage.dart | ||
coverage/ | ||
.test_runner.dart | ||
|
||
# Android studio and IntelliJ | ||
.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
*.class | ||
*.log | ||
*.pyc | ||
*.swp | ||
.DS_Store | ||
.atom | ||
.buildlog | ||
.history | ||
.svn | ||
migrate_working_dir | ||
*.iml | ||
*.ipr | ||
*.iws | ||
.idea | ||
.vscode | ||
pubspec.lock | ||
.dart_tool | ||
.packages | ||
build | ||
coverage | ||
dart_test.yaml | ||
test | ||
analysis_options.yaml | ||
example/* | ||
!example/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## 0.1.0 | ||
|
||
- 🎉 Initial version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Copyright 2024 lsaudon | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
## releascribe_cli | ||
|
||
[![License: MIT][license_badge]][license_link] | ||
|
||
Your Storyteller for Seamless Releases. | ||
|
||
--- | ||
|
||
## Getting Started 🚀 | ||
|
||
If the CLI application is available on [pub](https://pub.dev), activate globally via: | ||
|
||
```sh | ||
dart pub global activate releascribe_cli | ||
``` | ||
|
||
Or locally via: | ||
|
||
```sh | ||
dart pub global activate --source=path <path to this package> | ||
``` | ||
|
||
## Usage | ||
|
||
```sh | ||
# Sample command | ||
releascribe_cli sample | ||
|
||
# Sample command option | ||
releascribe_cli sample --cyan | ||
|
||
# Show CLI version | ||
releascribe_cli --version | ||
|
||
# Show usage help | ||
releascribe_cli --help | ||
``` | ||
|
||
## Running Tests with coverage 🧪 | ||
|
||
To run all unit tests use the following command: | ||
|
||
```sh | ||
dart pub global activate coverage 1.2.0 | ||
dart test --coverage=coverage | ||
dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info | ||
``` | ||
|
||
To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov). | ||
|
||
```sh | ||
# Generate Coverage Report | ||
genhtml coverage/lcov.info -o coverage/ | ||
|
||
# Open Coverage Report | ||
open coverage/index.html | ||
``` | ||
|
||
|
||
Generated by the [Very Good CLI][very_good_cli_link] 🤖 | ||
|
||
--- | ||
|
||
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg | ||
[license_link]: https://opensource.org/licenses/MIT | ||
[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli |
Oops, something went wrong.