Now that you have a git repository that will behave as a suede dependency, please perform the following tasks to complete the setup:

TODO

• Set Actions permissions (⚙️ Settings > ▶️ Actions > General > Workflow permissions)

  

  • Read and write permissions
  • Allow GitHub Actions to create and approve pull requests
• OPTIONAL (RECOMMENDED): Configure pull request head branches to automatically delete (⚙️ Settings > ⚙️ General > Pull Requests)

  

  • This is helpful to keep the branch list clean, as one of the included github actions automatically creates "chore" pull requests
• Dispatch initialization workflow (▶️ Actions > Initialization procedure > Run Workflow)

  

  • The action will:
    1. On the release branch, clone the suede core dependency into .suede/core (from the dependency/release/core branch) and push
    2. On the main branch, clone the suede core dependency into .suede/core (from the dependency/main/core branch) and push
    3. Clone a subrepo of the release branch into the ./release folder within the main branch (so that changes within the ./release folder of the main branch can be automatically synced to the release branch via .github/workflows/subrepo-push-release.yml)
    4. Replaces the content of this README with specifics around installing this repository as a subrepo dependency
    5. 💥SELF-DESTRUCT💥 (meaning it will delete .github/workflows/initialize.yml)

  [!NOTE] Why does init clone core in instead of the template shipping it directly? So that each dependency's .gitrepo file points at a real commit of its actual source repository — a baked-in copy would have no valid subrepo link to pull/push against. The GitHub Actions workflow files (under .github/workflows), by contrast, are baked into the template: GitHub refuses to let an action create or modify workflow files using the default GITHUB_TOKEN (it would require a higher-privileged PAT, which this setup intentionally avoids).

• OPTIONAL: Install a devcontainer
  • Initialization deliberately does not set one up — a dependency's development environment is its own choice, not something the library imposes. If you want one, install devcontainers-suede yourself:

    bash <(curl -fsSL https://suede.sh/install/release) --repo pmalacho-mit/devcontainers-suede --destination .suede/devcontainers-suede
    bash .suede/devcontainers-suede/install.sh <profile>.json