Skip to content

Commit 7304a10

Browse files
committed
docs: documents
1 parent f14222a commit 7304a10

File tree

8 files changed

+131
-0
lines changed

8 files changed

+131
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @ronnnnn

.github/workflows/lint-pr.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Lint PR Title
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
- reopened
10+
11+
permissions:
12+
pull-requests: read
13+
14+
jobs:
15+
lint-pr:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5.5.3
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21+
with:
22+
validateSingleCommit: true

.github/workflows/release.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
12+
jobs:
13+
release:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: GoogleCloudPlatform/release-please-action@v4
17+
with:
18+
release-type: node

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.github/CODEOWNERS
12
dist/
23
node_modules/
34
bun.lockb

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
## Installation
4+
5+
Install the tools listed in the `.tool-version` and `.node-version` files. You can easily set up the environment using either asdf or mise.
6+
7+
### asdf or mise
8+
9+
To install the tools using asdf, run the following command:
10+
11+
```shell
12+
# asdf
13+
asdf i
14+
15+
# mise
16+
mise i
17+
```
18+
19+
## Development
20+
21+
Setup development environment with `bun`.
22+
23+
```shell
24+
bun i
25+
```
26+
27+
Scripts are defined in `package.json`.
28+
You can check available scripts.
29+
30+
```shell
31+
bun run
32+
```

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<div align="center">
2+
3+
# setup-fluttergen
4+
5+
Install `fluttergen` command in GitHub Actions.
6+
7+
</div>
8+
9+
# Usage
10+
11+
```yaml
12+
- uses: FluttterGen/setup-fluttergen@v1
13+
with:
14+
version: 5.6.0
15+
```
16+
17+
# Inputs
18+
19+
| Name | Description | Required | Default |
20+
| ---------- | -------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------- |
21+
| version | FlutterGen version (optional, will be detected from project root .tool-versions or .mise.toml if not provided) | false | - |
22+
| cache | Cache FlutterGen CLI | false | true |
23+
| cache-key | Cache key for FlutterGen CLI | false | `fluttergen-${{ runner.os }}-${{ runner.arch }}-${{ version }}` |
24+
| cache-path | Cache path for FlutterGen CLI | false | `${{ runner.tool_cache }}/.fluttergen` |
25+
26+
# Outputs
27+
28+
| Name | Description |
29+
| ------- | ---------------------------- |
30+
| version | Installed FlutterGen version |

lefthook.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ pre-commit:
55
glob: '*'
66
exclude:
77
- .prettierignore
8+
- .github/CODEOWNERS
89
- dist/**/*
910
- node_modules/**/*
1011
- bun.lockb

renovate.json5

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
$schema: 'https://docs.renovatebot.com/renovate-schema.json',
3+
extends: [
4+
'config:js-lib',
5+
'group:typescript-eslintMonorepo',
6+
':semanticCommits',
7+
':semanticCommitTypeAll(chore)',
8+
':semanticCommitScopeDisabled',
9+
],
10+
branchPrefix: 'chore-renovate-',
11+
major: {
12+
minimumReleaseAge: '7 days',
13+
},
14+
minor: {
15+
minimumReleaseAge: '3 days',
16+
},
17+
patch: {
18+
minimumReleaseAge: '2 days',
19+
},
20+
configMigration: false,
21+
vulnerabilityAlerts: {
22+
enabled: true,
23+
labels: ['A-dependencies', 'A-security'],
24+
},
25+
osvVulnerabilityAlerts: false,
26+
}

0 commit comments

Comments
 (0)