You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
New mcp_server action for .github/workflows/bump.yml
=> On GitHub action, use keyword mcp_server
```
with:
command: deploy
mcp_server: <BUMP_MCP_SERVER_ID_OR_SLUG>
token: ${{secrets.BUMP_TOKEN}}
file: doc/flower-document.yml
```
=> New command transmitted to bump-cli:
`bump deploy --mcp_server mcp_server_id_or_slug doc/flower-document.yml`
=> New request sent to Bump.sh API:
`POST /api/v1/mcp_servers/{mcp_server_id_or_slug}/deploy`
the GitHub action should be used to deploy a workflow document
on Bump.sh API ✨
-[Diff on pull requests only](#diff-on-pull-requests-only)
35
35
36
+
This GitHub action can be utilized to interact with the MCP server and workflow definition on bump.sh hosted on Bump.sh:
37
+
38
+
-[Deploy workflow document for your MCP server](#deploy-workflow-document-for-your-MCP-Server)
39
+
36
40
### Deploy documentation & diff on pull requests
37
41
38
42
This is the most common worklow that we [recommend using](https://docs.bump.sh/help/continuous-integration/), which will create two steps in your automation flow: a validation & diff step on code reviews, followed by a deployment step on merged changes.
@@ -161,7 +165,7 @@ jobs:
161
165
162
166
### Deploy a single documentation on a hub
163
167
164
-
You can deploy a documentation inside a hub by adding a `hub` slug or id.
168
+
You can deploy a documentation inside a hub by adding a `hub` slug or id.
165
169
Note that the documentation will be automatically created if it doesn't exist by using the slug you defined with the `doc:` input.
166
170
167
171
`.github/workflows/bump.yml`
@@ -254,6 +258,40 @@ In order to deploy the 3 services API definition files from this folder (`privat
254
258
filename_pattern: '*-api-{slug}-service'
255
259
```
256
260
261
+
### Deploy workflow document for your MCP server
262
+
263
+
You'll need to get the slug (or id) of your MCP Server,
264
+
accessible on bump.sh: https://bump.sh/{your-organization}/workflow/set/{mcp-server-id}/tokens
265
+
266
+
Copy the slug (we can call it BUMP_MCP_SERVER_ID_OR_SLUG) and use it with command deploy,
267
+
with link to your flower specification:
268
+
269
+
`.github/workflows/bump.yml`
270
+
271
+
```yaml
272
+
name: Deploy workflow document for your MCP server
273
+
274
+
on:
275
+
push:
276
+
branches:
277
+
- main
278
+
279
+
jobs:
280
+
deploy-workflow-document:
281
+
name: Deploy workflow document for MCP server on Bump.sh
282
+
runs-on: ubuntu-latest
283
+
steps:
284
+
- name: Checkout
285
+
uses: actions/checkout@v4
286
+
- name: Deploy workflow document
287
+
uses: bump-sh/github-action@v1
288
+
with:
289
+
command: deploy
290
+
mcp_server: <BUMP_MCP_SERVER_ID_OR_SLUG>
291
+
token: ${{secrets.BUMP_TOKEN}}
292
+
file: doc/flower-document.yml
293
+
```
294
+
257
295
## Inputs
258
296
259
297
* `doc` (required unless you deploy a directory on a hub): Documentation slug or id. Can be found in the documentation settings on https://bump.sh/dashboard
@@ -274,7 +312,7 @@ In order to deploy the 3 services API definition files from this folder (`privat
274
312
275
313
* `command`: Bump.sh command to execute. _Default: `deploy`_
276
314
277
-
* `deploy`: deploy a new version of the documentation
315
+
* `deploy`: deploy a new version of the documentation (or MCP Server ✨)
278
316
* `diff`: automatically comment your pull request with the API diff
279
317
* `dry-run`: dry-run a deployment of the documentation file
280
318
* `preview`: create a temporary preview
@@ -283,6 +321,8 @@ In order to deploy the 3 services API definition files from this folder (`privat
283
321
284
322
* `fail_on_breaking` (optional): Mark the action as failed when a breaking change is detected with the diff command. This is only valid with `diff` command.
285
323
324
+
* `mcp_server` (required to deploy workflow document on MCP server): MCP Server id or slug. Can be found MCP Server settings: https://bump.sh/{your-organization}/workflow/set/{mcp-server-id}/tokens. This is only valid with the `deploy` command (default command).
325
+
286
326
## Contributing
287
327
288
328
Bug reports and pull requests are welcome on GitHub at https://github.com/bump-sh/github-action. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -293,4 +333,4 @@ The scripts and documentation in this project are released under the [MIT Licens
293
333
294
334
## Code of Conduct
295
335
296
-
Everyone interacting in the Bump `github-action` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bump-sh/github-action/blob/master/CODE_OF_CONDUCT.md).
336
+
Everyone interacting in the Bump.sh `github-action` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bump-sh/github-action/blob/master/CODE_OF_CONDUCT.md).
Copy file name to clipboardExpand all lines: action.yml
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,8 @@ inputs:
29
29
filename_pattern:
30
30
default: "{slug}-api"
31
31
description: "Filename pattern to extract the documentation slug from filenames when deploying a DIRECTORY. Pattern uses only '*' and '{slug}' as special characters to extract the slug from a filename without extension. Only used with the 'hub' input when deploying a whole directory ."
32
+
mcp_server:
33
+
description: "MCP Server id or slug. Necessary to deploy a new workflow documentation to be run by your MCP Server."
0 commit comments