Merge branch 'master' into dependabot/pip/werkzeug-2.2.3

README.md

@@ -74,6 +74,7 @@ Read on for a full description of all of the available configuration options.
   - [Pre-Release Hooks](#pre-release-hooks)
   - [Release Branch Selection](#release-branch-selection)
   - [Release Branch Management](#release-branch-management)
+  - [Subpackage Configuration](#subpackage-configuration)
 - [Local Usage](#local-usage)
 
 ## Basic Configuration Options
@@ -374,6 +375,69 @@ with:
   branches: true
 ```
 
+### Subpackage Configuration
+
+If your package is not at the top-level of your repository, you should set the  `subdir` input:  
+
+```yml
+with:
+  token: ${{ secrets.GITHUB_TOKEN }}
+  subdir: path/to/SubpackageName.jl
+```
+
+Version tags will then be prefixed with the subpackage's name: `{PACKAGE}-v{VERSION}`, e.g., `SubpackageName-v0.2.3`. (For top-level packages, the default tag is simply `v{VERSION}`.) 
+
+To tag releases from a monorepo containing multiple subpackages and an optional top-level package, set up a separate step for each package you want to tag. For example, to tag all three packages in the following repository,
+
+```
+.
+├── SubpackageA.jl
+│   ├── Package.toml
+│   └── src/...
+├── path
+│   └── to
+│       └── SubpackageB.jl
+│           ├── Package.toml
+│           └── src/...
+├── Package.toml
+└── src/...
+```
+
+the action configuration should look something like
+
+```yml
+    steps:
+      - name: Tag top-level package
+        uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Edit the following line to reflect the actual name of the GitHub Secret containing your private key
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          # ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}
+      - name: Tag subpackage A
+        uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Edit the following line to reflect the actual name of the GitHub Secret containing your private key
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          # ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}
+          subdir: SubpackageA.jl
+      - name: Tag subpackage B
+        uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Edit the following line to reflect the actual name of the GitHub Secret containing your private key
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          # ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}
+          subdir: path/to/SubpackageB.jl
+```
+
+Generated tags will then be `v0.1.2` (top-level), `SubpackageA-v0.0.3`, and `SubpackageB-v2.3.1`.
+
+**:information_source: Monorepo-specific changelog behavior**
+
+  Each subpackage will include all issues and pull requests in its changelogs, such that a single issue will be duplicated up in all of the repository's subpackages' release notes. Careful [`changelog_ignore` and/or custom changelog settings](#changelogs) on a per-subpackage basis can mitigate this duplication.  
+
 ## Local Usage
 
 There are some scenarios in which you want to manually run TagBot.
@@ -392,6 +456,7 @@ Options:
   --github-api TEXT  GitHub API URL
   --changelog TEXT   Changelog template
   --registry TEXT    Registry to search
+  --subdir TEXT      Subdirectory path in repo
   --help             Show this message and exit.
 
 $ docker run --rm ghcr.io/juliaregistries/tagbot python -m tagbot.local \

action.yml

@@ -63,6 +63,9 @@ inputs:
   branch:
     description: Branch to create releases against when possible
     required: false
+  subdir:
+    description: Subdirectory of package in repo, if not at top level
+    required: false
   changelog:
     description: Changelog template
     required: false