Repository navigation
chore: adopt Very Good CLI release and repo conventions #100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
2788e26
chore: adopt Very Good CLI release and repo conventions
ryzizub 7e5a172
chore: correct the release-please setup from review
ryzizub a89c64e
chore: drop bootstrap-sha, the 0.1.0 tags mark the baseline
ryzizub 4fc3abe
chore: release the repository as one unit
ryzizub affd731
chore: publish both packages to pub.dev
ryzizub 7e6f003
chore: release the two packages in lockstep instead of from the root
ryzizub File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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 @@ | ||
| # Every request must be reviewed and accepted by: | ||
|
|
||
| * @VeryGoodOpenSource/codeowners | ||
File renamed without changes.
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -25,6 +25,7 @@ | |
| "frontmatter", | ||
| "gemini", | ||
| "kevmoo", | ||
| "lycheeignore", | ||
| "mcp", | ||
| "opencode", | ||
| "prereqs", | ||
|
|
||
This file contains hidden or 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,30 @@ | ||
| name: check_links | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| schedule: | ||
| # Runs every Monday at 08:00 UTC | ||
| - cron: "0 8 * * 1" | ||
|
|
||
| jobs: | ||
| check_links: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v7 | ||
|
|
||
| - name: 🔗 Link Checker | ||
| uses: lycheeverse/lychee-action@v2 | ||
| with: | ||
| # The repository is private, so GitHub links need a token to resolve. | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| args: ./**/*.md | ||
| fail: true |
This file contains hidden or 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,35 @@ | ||
| name: pub_publish | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - "v[0-9]+.[0-9]+.[0-9]+*" # tag pattern on pub.dev: 'v{{version}}' | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| publish: | ||
| permissions: | ||
| id-token: write # Required for authentication using OIDC | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: 📚 Git Checkout | ||
| uses: actions/checkout@v7 | ||
|
|
||
| - name: 🎯 Setup Dart | ||
| uses: dart-lang/setup-dart@v1.8.1 | ||
| with: | ||
| sdk: "3.13.0" | ||
|
|
||
| - name: 📦 Install Dependencies | ||
| run: dart pub get | ||
|
|
||
| # plugin_source first: the CLI resolves it from pub.dev, so publishing | ||
| # the CLI against a version that is not there yet fails. | ||
| - name: 📢 Publish plugin_source | ||
| working-directory: packages/plugin_source | ||
| run: dart pub publish --force | ||
|
|
||
| - name: 📢 Publish vgv_ai_cli | ||
| working-directory: packages/vgv_ai_cli | ||
| run: dart pub publish --force |
This file contains hidden or 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,26 @@ | ||
| name: release_please | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
|
marcossevilla marked this conversation as resolved.
Resolved
|
||
| release_please: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: 🚀 Release Please | ||
| uses: googleapis/release-please-action@v5 | ||
| with: | ||
| token: ${{ secrets.RELEASE_PLEASE_TOKEN }} | ||
| manifest-file: ".release-please-manifest.json" | ||
| config-file: ".release-please-config.json" | ||
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -28,3 +28,7 @@ coverage/ | |
| docs/ | ||
|
|
||
| tasks/ | ||
|
|
||
| # Mason | ||
| .mason/ | ||
| mason-lock.json | ||
This file contains hidden or 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,8 @@ | ||
| # Lychee ignore patterns | ||
| # See https://github.com/lycheeverse/lychee for documentation | ||
|
|
||
| # Dart string interpolation quoted in docs, picked up as literal link text | ||
| \$\{ | ||
|
|
||
| # Private sibling repositories the workflow token cannot read | ||
| ^https://github\.com/VeryGoodOpenSource/vgv-wingspan |
This file contains hidden or 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,34 @@ | ||
| { | ||
| "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json", | ||
| "changelog-sections": [ | ||
| { "type": "feat", "section": "Features" }, | ||
| { "type": "fix", "section": "Bug Fixes" }, | ||
| { "type": "refactor", "section": "Refactors" }, | ||
| { "type": "chore", "section": "Miscellaneous Chores" }, | ||
| { "type": "docs", "section": "Docs" } | ||
| ], | ||
| "pull-request-header": ":rotating_light: There are changes ready for release :rocket:\n\nℹ Merge this PR once the team confirms the release is ready.\n", | ||
| "group-pull-request-title-pattern": "chore: release ${branch}", | ||
| "include-component-in-tag": true, | ||
| "packages": { | ||
| "packages/vgv_ai_cli": { | ||
| "release-type": "dart", | ||
| "component": "vgv_ai_cli", | ||
| "changelog-path": "CHANGELOG.md", | ||
| "include-component-in-tag": false, | ||
| "extra-files": ["pubspec.yaml", "lib/src/version.dart"] | ||
| }, | ||
| "packages/plugin_source": { | ||
| "release-type": "dart", | ||
| "component": "plugin_source", | ||
| "changelog-path": "CHANGELOG.md" | ||
| } | ||
| }, | ||
| "plugins": [ | ||
| { | ||
| "type": "linked-versions", | ||
| "groupName": "vgv_ai", | ||
| "components": ["vgv_ai_cli", "plugin_source"] | ||
| } | ||
| ] | ||
| } |
This file contains hidden or 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,4 @@ | ||
| { | ||
| "packages/vgv_ai_cli": "0.1.0", | ||
| "packages/plugin_source": "0.1.0" | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -1,5 +1,3 @@ | ||
| tags: | ||
| version-verify: | ||
| skip: "Should only be run during pull request. Verifies if version file is updated." | ||
| pinned-plugins: | ||
| skip: "Clones the real pinned plugins over the network. Run in CI by verify-pins." |
This file contains hidden or 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 @@ | ||
| # Example | ||
|
|
||
| `vgv_ai` is used from the terminal. See [../README.md](../README.md) for usage. |
This file contains hidden or 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 |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| // Generated code. Do not modify. | ||
| const packageVersion = '0.1.0'; | ||
| // Managed by release-please. Do not edit by hand. | ||
| const packageVersion = '0.1.0'; // x-release-please-version |
This file contains hidden or 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
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.