@ggdna/dna-gg 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) ggsuite
+
+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.

package/README.md

@@ -0,0 +1,76 @@
+# dna_gg
+
+The DNA layer for the `gg` CLI workflow: ticket, commit, push, review,
+publish.
+
+## Guides
+
+- `dna/doc/guides/develop-guide.md`,
+  `dna/doc/guides/develop-without-ai-guide.md` — the ticket driven
+  workflow, with and without an AI
+- `dna/doc/guides/for-ai/ai-dev-guide.md` — the same workflow as
+  instructions for an agent
+- `dna/doc/guides/install-guide/install-gg-guide.md`,
+  `dna/doc/guides/install-guide/install-gg-workspace-guide.md` — install
+  `gg` and set up a workspace
+
+## Skills
+
+- `/ticket` — creates a ticket and adds the repos it needs
+- `/commit` — proposes a message and commits through `gg do commit`
+- `/push` — pushes the ticket branches
+- `/publish` — releases the ticket
+- `/cleanup` — removes what the ticket left behind
+
+## Scripts
+
+- `dna/scripts/setup-github-repo.js` — applies the branch rules a new repo
+  needs, called by the create repo guide
+- `dna/scripts/rename-class.js` — renames a template project to its real
+  name
+- `dna/scripts/wait-for-pr.js` — waits for the pull request to merge
+- `dna/scripts/delete-feature-branch.js` — removes the branch after the
+  merge
+- `dna/scripts/functions/` — the helpers those scripts share
+
+## Configuration
+
+- `dna/dot-github/workflows/quick_check.yaml` — the quick check pipeline
+  every pull request has to pass
+
+## Layers
+
+Builds on [dna_install](https://github.com/ggdna/dna_install) for the
+install overview and [dna_index](https://github.com/ggdna/dna_index) for
+the repo index every gg repo keeps.
+
+It extends the `@tooling` section of the install overview through
+`dna/doc/guides/install-guide.overrides.md`: it adds `Install gg` and
+appends the `Workspace` section.
+
+## Variables
+
+- `dnaCopyrightHolder` — the name in the license header of every file
+- `dnaCompany`, `dnaGitOrg`, `dnaGitOrgUrl` — the organization repos are
+  created in
+- `dnaJiraPrefix` — the prefix of a ticket id
+- `dnaGitQuickCheckPipelineName` — the name the branch rules require
+- `dnaPubDevPublisher` — the pub.dev publisher packages are transferred to
+
+## Usage
+
+Declare it as a dev-dependency and initialize once:
+
+```bash
+pnpm add -D @ggdna/dna-gg   # TypeScript projects
+dart pub add dev:dna_gg     # Dart projects
+helix init
+```
+
+The placed test instantiates and verifies the DNA on every test run.
+
+## Development
+
+The `dna/` folder is hand-authored source and is never generated. The repo
+instantiates its own DNA — run `dart test` after changes; commit first, a
+file the DNA would overwrite must not carry uncommitted work.

package/dna/_dna.json

@@ -0,0 +1,10 @@
+{
+  // This package is a DNA layer: dna/ is hand-authored source and is the
+  // last layer of its own instantiation.
+  "version": 1,
+
+  // The parent DNAs. dna_install brings the install overview this layer
+  // extends with the gg install guides, dna_index the index conventions
+  // every gg repo follows. Parents first, this layer wins.
+  "layers": ["dna_install", "dna_index"]
+}

package/dna/_generated.json

@@ -0,0 +1,204 @@
+{
+  "version": 1,
+  "layers": [
+    {
+      "name": "base",
+      "package": "helix",
+      "ecosystem": null,
+      "resolvedVersion": "1.0.1",
+      "via": null,
+      "hash": "0x705e486e88a93125"
+    },
+    {
+      "name": "dna-install",
+      "package": "@ggdna/dna-install",
+      "ecosystem": "node",
+      "resolvedVersion": "0.1.0",
+      "via": null,
+      "hash": "0xbe88eb4256745ee1"
+    },
+    {
+      "name": "dna-index",
+      "package": "@ggdna/dna-index",
+      "ecosystem": "node",
+      "resolvedVersion": "0.1.0",
+      "via": null,
+      "hash": "0x1d92b0add37a1ac7"
+    },
+    {
+      "name": "self",
+      "package": null,
+      "ecosystem": null,
+      "resolvedVersion": null,
+      "via": null,
+      "hash": "0x2a90594a14522652"
+    }
+  ],
+  "claude": {
+    "claudeMdInclude": null
+  },
+  "baseVersion": "1.0.1",
+  "baseHash": "0x705e486e88a93125",
+  "instances": [
+    {
+      "path": ".claude/skills/cleanup/SKILL.md",
+      "hash": "0xc5c7b7940ab51b83"
+    },
+    {
+      "path": ".claude/skills/commit/SKILL.md",
+      "hash": "0xad0e75ab4d725133"
+    },
+    {
+      "path": ".claude/skills/index/SKILL.md",
+      "hash": "0xc47429e51622cd7b"
+    },
+    {
+      "path": ".claude/skills/install/SKILL.md",
+      "hash": "0x29c4ded946b50053"
+    },
+    {
+      "path": ".claude/skills/publish/SKILL.md",
+      "hash": "0xb8e70eff3563f75d"
+    },
+    {
+      "path": ".claude/skills/push/SKILL.md",
+      "hash": "0x76c357ca9933317d"
+    },
+    {
+      "path": ".claude/skills/ticket/SKILL.md",
+      "hash": "0xbc13efe6fa9af962"
+    },
+    {
+      "path": ".github/workflows/quick_check.yaml",
+      "hash": "0xa61b5062f48e430c"
+    },
+    {
+      "path": "doc/guides/develop-guide.md",
+      "hash": "0xbd9fa5efab7af735"
+    },
+    {
+      "path": "doc/guides/develop-without-ai-guide.md",
+      "hash": "0xe74449f72357f23c"
+    },
+    {
+      "path": "doc/guides/for-ai/ai-dev-guide.md",
+      "hash": "0x3d2812a1dfb025cf"
+    },
+    {
+      "path": "doc/guides/index-guide.md",
+      "hash": "0xc684cc8895b98403"
+    },
+    {
+      "path": "doc/guides/install-guide.md",
+      "hash": "0x4c0b8fb54b2c4636"
+    },
+    {
+      "path": "doc/guides/install-guide/install-azure-cli-guide.md",
+      "hash": "0xe0206afa5fc5b085"
+    },
+    {
+      "path": "doc/guides/install-guide/install-azure-npm-feed-guide.md",
+      "hash": "0x902df0b6dc38a92b"
+    },
+    {
+      "path": "doc/guides/install-guide/install-brew-on-mac-guide.md",
+      "hash": "0x5bf663dc011c4330"
+    },
+    {
+      "path": "doc/guides/install-guide/install-corepack-guide.md",
+      "hash": "0x906ecd19a3b2366b"
+    },
+    {
+      "path": "doc/guides/install-guide/install-flutter-guide.md",
+      "hash": "0x883c40d890bd3d5e"
+    },
+    {
+      "path": "doc/guides/install-guide/install-gg-guide.md",
+      "hash": "0xa093431b02c398d6"
+    },
+    {
+      "path": "doc/guides/install-guide/install-gg-workspace-guide.md",
+      "hash": "0x846766914bb56a84"
+    },
+    {
+      "path": "doc/guides/install-guide/install-github-cli-guide.md",
+      "hash": "0xcce9cbcd56f78b1f"
+    },
+    {
+      "path": "doc/guides/install-guide/install-node-mac-guide.md",
+      "hash": "0x1f4eb7cf63b5c9db"
+    },
+    {
+      "path": "doc/guides/install-guide/install-node-win-guide.md",
+      "hash": "0x782756eb0ff83a0d"
+    },
+    {
+      "path": "doc/guides/install-guide/install-vscode-guide.md",
+      "hash": "0xa0da6a6877bb94c2"
+    },
+    {
+      "path": "doc/hello_world.md",
+      "hash": "0x0903f7fc5224f6f1"
+    },
+    {
+      "path": "doc/templates/index-template.jsonc",
+      "hash": "0x16c3a8d50c72ed6d"
+    },
+    {
+      "path": "scripts/delete-feature-branch.js",
+      "hash": "0x219ac0a3635ee644"
+    },
+    {
+      "path": "scripts/functions/colors.js",
+      "hash": "0xdfd97f3804665811"
+    },
+    {
+      "path": "scripts/functions/current-branch.js",
+      "hash": "0xb9ebbadf45893278"
+    },
+    {
+      "path": "scripts/functions/directories.js",
+      "hash": "0x148d4ebb8aa75523"
+    },
+    {
+      "path": "scripts/functions/get-repo-urls.js",
+      "hash": "0x4c7b3897973acec3"
+    },
+    {
+      "path": "scripts/functions/get-version.js",
+      "hash": "0xfe46316558755cf2"
+    },
+    {
+      "path": "scripts/functions/is-clean-repo.js",
+      "hash": "0x8aa95ca51d9d6517"
+    },
+    {
+      "path": "scripts/functions/is-main-up-to-date.js",
+      "hash": "0xe1ab1826d0ddd039"
+    },
+    {
+      "path": "scripts/functions/pull-request-url.js",
+      "hash": "0x5398755a61a59928"
+    },
+    {
+      "path": "scripts/functions/run-command.js",
+      "hash": "0x085b390fcb9256ab"
+    },
+    {
+      "path": "scripts/functions/sync-folders.js",
+      "hash": "0x4f83165fd92ec49d"
+    },
+    {
+      "path": "scripts/rename-class.js",
+      "hash": "0xa9daec4f3ea514b7"
+    },
+    {
+      "path": "scripts/setup-github-repo.js",
+      "hash": "0x5907588070a580ca"
+    },
+    {
+      "path": "scripts/wait-for-pr.js",
+      "hash": "0x1360c661984b78a8"
+    }
+  ]
+}

package/dna/_vars.json

@@ -0,0 +1,9 @@
+{
+  "dnaCompany": "ggsuite",
+  "dnaCopyrightHolder": "ggsuite",
+  "dnaGitOrg": "ggsuite",
+  "dnaGitOrgUrl": "https://github.com/dnaGitOrg",
+  "dnaGitQuickCheckPipelineName": "Quick Check",
+  "dnaJiraPrefix": "GGS",
+  "dnaPubDevPublisher": "inlavigo.com"
+}

package/dna/doc/guides/develop-guide.md

@@ -0,0 +1,41 @@
+<!--
+@license
+Copyright (c) dnaCopyrightHolder
+
+Use of this source code is governed by terms that can be
+found in the LICENSE file in the root of this package.
+-->
+
+# Development guide
+
+[Install the required software](./install-guide.md)
+
+[Prepare a GG workspace](./install-guide/install-gg-workspace-guide.md)
+
+Switch into the workspace
+
+```bash
+cd ~/dev/ # workspace
+```
+
+Start claude
+
+```bash
+claude
+```
+
+Start the development in Claude
+
+```bash
+/ticket
+```
+
+Use the following skills in Claude
+
+```bash
+/commit
+/push
+/review
+/publish
+/cleanup
+```

package/dna/doc/guides/develop-without-ai-guide.md

@@ -0,0 +1,63 @@
+<!--
+@license
+Copyright (c) dnaCopyrightHolder
+
+Use of this source code is governed by terms that can be
+found in the LICENSE file in the root of this package.
+-->
+
+# Develop without AI
+
+## Prepare everything
+
+If you have not done that yet:
+
+[Install the required software](./install-guide.md)
+
+[Initialize a gg workspace](./install-guide/install-gg-workspace-guide.md)
+
+## Switch into your workspace
+
+```bash
+cd ~/dev/
+```
+
+## Add tickets
+
+```bash
+gg do add repo1 repo2
+```
+
+## Open the workspace in Vscode
+
+```bash
+gg do code
+```
+
+## Implement
+
+Implement your features based on the guides
+
+## Commit
+
+```bash
+gg do commit
+```
+
+## Push
+
+```bash
+gg do push
+```
+
+## Review
+
+```bash
+gg do review
+```
+
+## Publish
+
+```bash
+gg do publish
+```

package/dna/doc/guides/for-ai/ai-dev-guide.md

@@ -0,0 +1,97 @@
+<!--
+@license
+Copyright (c) dnaCopyrightHolder
+
+Use of this source code is governed by terms that can be
+found in the LICENSE file in the root of this package.
+-->
+
+# Development guide for AIs
+
+## Ask the developer for the ticket infos
+
+- Ask for the ticket ID
+- Ask for the ticket title
+- Ask for the ticket description
+
+## Replace in this document
+
+- Replace `~/dev/` by the workspace directory from the memory
+- Ask for the workspace directory if none is known
+- Replace `dnaJiraPrefix-145` by the ticket ID you asked for
+- Replace `Fix issue abc` by the ticket title you asked for
+
+## Create a ticket
+
+```bash
+cd ~/dev/ # workspace
+gg do create ticket dnaJiraPrefix-145 -m"Fix issue abc"
+cd tickets/dnaJiraPrefix-145
+```
+
+## Add git repositories
+
+Look at the `index.jsonc` of each repo in .ocean and decide which repos need to
+be added to the ticket.
+Make a plan for how you roughly want to implement the ticket.
+If certain parts of the implementation belong to a domain that does not yet
+exist in the .ocean folder, consider creating a new repository.
+Ask the user about this. Also explain to the user what you roughly want to
+change in which repo to implement the ticket and let them confirm that the
+corresponding repos are added to the ticket.
+
+After the user's confirmation, add the repos to the ticket:
+
+```bash
+gg do add repo1 repo2
+```
+
+## Open the workspace in Vscode
+
+```bash
+gg do code
+```
+
+## Implement
+
+Implement your features based on the guides
+
+## Commit
+
+```bash
+gg do commit
+```
+
+## Push
+
+```bash
+gg do push
+```
+
+## Review
+
+Let the user confirm that the review phase is started.
+
+```bash
+gg do review
+```
+
+gg creates pull requests for each repo and prints the URLs to the
+terminal.
+
+Afterwards load the review-light skill and execute it.
+
+## Publish
+
+- Create a blog post for the current ticket
+- Update the index.jsonc and README.md
+- Create the configuration for gg do publish
+
+Ask the user to run the following command **manually**:
+
+```bash
+gg do publish
+```
+
+gg triggers the pull request merge and publishes the changes to the
+registry. Finally the version tag is created and pushed.

package/dna/doc/guides/install-guide/install-gg-guide.md

@@ -0,0 +1,75 @@
+<!--
+@license
+Copyright (c) dnaCopyrightHolder
+
+Use of this source code is governed by terms that can be
+found in the LICENSE file in the root of this package.
+-->
+
+# Install gg
+
+`gg` is the unified Dart CLI used for development at dnaCompany. It runs
+pre-commit checks in a single repository and orchestrates commits, pushes,
+reviews and publishes across all repositories of a ticket.
+
+## Prerequisites
+
+Install [Flutter](./install-flutter-guide.md) first. It provides the `dart`
+command used below.
+
+```bash
+dart --version
+```
+
+## Install gg
+
+```bash
+dart pub global activate gg
+```
+
+## Add the pub cache to your PATH
+
+Globally activated Dart executables are installed into the pub cache. Add its
+`bin` folder to your `PATH`, otherwise the `gg` command will not be found.
+
+Mac and Linux:
+
+```bash
+echo 'export PATH="$HOME/.pub-cache/bin:$PATH"' >> ~/.zshrc
+source ~/.zshrc
+```
+
+On Windows, add the following folder to your `Path` environment variable:
+
+```text
+%LOCALAPPDATA%\Pub\Cache\bin
+```
+
+Restart your terminal afterwards.
+
+## Verify installation
+
+```bash
+gg --help
+```
+
+## Update gg
+
+Run the activation again to install the latest version:
+
+```bash
+dart pub global activate gg
+```
+
+## Usage
+
+`gg` is ticket driven: run it inside a ticket and every action applies to
+all repositories that belong to that ticket.
+
+```bash
+gg                # the command groups: do, can, did
+gg do -h          # everything you can act on
+gg can commit     # check before committing
+```
+
+See also the [Develop Guide](../develop-guide.md).

package/dna/doc/guides/install-guide/install-gg-workspace-guide.md

@@ -0,0 +1,28 @@
+<!--
+@license
+Copyright (c) dnaCopyrightHolder
+
+Use of this source code is governed by terms that can be
+found in the LICENSE file in the root of this package.
+-->
+
+# Create a gg workspace
+
+## Create a dev dir
+
+```bash
+mkdir -p ~/dev2
+cd ~/dev2
+```
+
+## Init a gg workspace
+
+```bash
+gg do init workspace
+```
+
+## Add your repositories
+
+```bash
+gg do add dnaOrgUrl
+```

package/dna/doc/guides/install-guide.overrides.md

@@ -0,0 +1,9 @@
+## @tooling Tooling
+
+- [Install the GitHub CLI](./install-guide/install-github-cli-guide.md)
+- [Install Flutter](./install-guide/install-flutter-guide.md)
+- [Install gg](./install-guide/install-gg-guide.md)
+
+## Workspace
+
+- [Create a gg workspace](./install-guide/install-gg-workspace-guide.md)

package/dna/dot-claude/skills/cleanup/SKILL.md

@@ -0,0 +1,49 @@
+---
+name: cleanup
+description: Removes what a published ticket left behind — feature branches, the ticket folder, and a stale workspace. Use when the user says "/cleanup" or asks to clean up after a release.
+---
+
+# Clean up after the publish
+
+Run this only when the ticket is published. `gg do publish` already offers to
+delete the ticket and its remote feature branches — if the user accepted
+that, only step 4 is left.
+
+## 1. Verify that everything landed
+
+Per repo of the ticket:
+
+```bash
+git status --porcelain      # must be empty
+git log origin/main --oneline -3
+```
+
+Stop and report if a repo still holds uncommitted or unmerged work.
+
+## 2. Delete the feature branches
+
+In every repo that still sits on its feature branch:
+
+```bash
+node scripts/delete-feature-branch.js
+```
+
+The script switches to `main`, pulls, and deletes the branch only when it is
+fully merged.
+
+## 3. Remove the ticket folder
+
+```bash
+cd ~/dev/ # workspace
+rm -rf tickets/DnaJiraPrefix-145
+```
+
+## 4. Update the workspace
+
+Pull `main` in the repos the ticket touched, so the workspace matches the
+release.
+
+## Important
+
+- Never delete a ticket whose pull requests are still open.
+- Ask before removing the ticket folder — it may still hold notes.