feat(github): add cheatsheet to a pr description

Author: dangreen

packages/github/src/cheatsheet.ts

@@ -0,0 +1,114 @@
+export const CHEATSHEET = `
+
+You can configure the bot's behavior through a pull request comment using the \`!simple-release/set-options\` command.
+
+### Command Format
+
+\`\`\`\`md
+!simple-release/set-options
+
+\`\`\`json
+{
+  "bump": {},
+  "publish": {}
+}
+\`\`\`
+\`\`\`\`
+
+### Useful Parameters
+
+#### Bump
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| \`version\` | \`string\` | Force set specific version |
+| \`as\` | \`'major' \\| 'minor' \\| 'patch' \\| 'prerelease'\` | Release type |
+| \`prerelease\` | \`string\` | Pre-release identifier (e.g., "alpha", "beta") |
+| \`byProject\` | \`Record<string, object>\` | Per-project bump options for monorepos |
+| \`firstRelease\` | \`boolean\` | Whether this is the first release |
+| \`skip\` | \`boolean\` | Skip version bump |
+| \`force\` | \`boolean\` | Ignore that project is private |
+
+#### Publish
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| \`access\` | \`'public' \\| 'restricted'\` | Package access level |
+| \`tag\` | \`string\` | Tag for npm publication |
+
+### Usage Examples
+
+#### Force specific version
+
+\`\`\`\`md
+!simple-release/set-options
+
+\`\`\`json
+{
+  "bump": {
+    "version": "2.0.0"
+  }
+}
+\`\`\`
+\`\`\`\`
+
+#### Force major bump
+
+\`\`\`\`md
+!simple-release/set-options
+
+\`\`\`json
+{
+  "bump": {
+    "as": "major"
+  }
+}
+\`\`\`
+\`\`\`\`
+
+#### Create alpha pre-release
+
+\`\`\`\`md
+!simple-release/set-options
+
+\`\`\`json
+{
+  "bump": {
+    "prerelease": "alpha"
+  }
+}
+\`\`\`
+\`\`\`\`
+
+#### Publish with specific access and tag
+
+\`\`\`\`md
+!simple-release/set-options
+
+\`\`\`json
+{
+  "bump": {
+    "prerelease": "beta"
+  },
+  "publish": {
+    "access": "public",
+    "tag": "beta"
+  }
+}
+\`\`\`
+\`\`\`\`
+
+### Access Restrictions
+
+The command can only be used by users with permissions:
+- repository owner
+- organization member
+- collaborator
+
+### Notes
+
+- The last comment with \`!simple-release/set-options\` command takes priority
+- JSON must be valid, otherwise the command will be ignored
+- Parameters apply only to the current release execution
+- The command can be updated by editing the comment or adding a new one
+`

packages/github/src/index.ts

@@ -5,6 +5,7 @@ import {
   type CreatePullRequestOptions,
   GitRepositoryHosting
 } from '@simple-release/core'
+import { CHEATSHEET } from './cheatsheet.js'
 
 export { Octokit }
 
@@ -155,6 +156,14 @@ export class GithubHosting extends GitRepositoryHosting {
 ---
 This PR was generated with [simple-release](https://github.com/TrigenSoftware/simple-release).
 
+<details>
+<summary>📄 Cheatsheet</summary>
+<br>
+
+${CHEATSHEET}
+
+</details>
+
 <!--
   Please do not edit this comment.
   simple-release-pull-request: true