Skip to content

Add readme and automatic deploy for workflows #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulRbr merged 1 commit into from
Jul 8, 2026
Merged

Add readme and automatic deploy for workflows #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,16 @@ jobs:
- run: ./.github/scripts/deploy-all.sh
env:
ORGANIZATION_DEMO_BUMP_TOKEN: ${{ secrets.ORGANIZATION_DEMO_BUMP_TOKEN }}

deploy-workflows:
runs-on: ubuntu-latest
name: Deploy Workflows on Bump
steps:
- name: Checkout
uses: actions/checkout@v7
- name: Deploy Weather workflow document
uses: bump-sh/github-action@v1
with:
mcp_server: "cdb8573a-fd90-461a-a869-a6166a542592"
token: ${{secrets.ORGANIZATION_DEMO_BUMP_TOKEN}}
file: workflows/weather.yml
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This directory holds [OpenAPI](https://spec.openapis.org/oas/latest.html) & [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest) example API contract files for [standalone APIs](https://github.com/bump-sh/examples/tree/main/apis) and [API Hubs](https://github.com/bump-sh/examples/tree/main/hubs) which are deployed to [bump.sh](https://bump.sh) to generate elegant and always up-to-date API documentation.

It also holds [Flower](https://github.com/bump-sh/flower-spec) example Workflow files which can generate servers (REST & MCP endpoints) to run your always up-to-date workflows defined thanks to their Flower or [Arazzo](https://spec.openapis.org/arazzo/latest.html) definition file.

## View example standalone API contract files and generated documentation

You can find all available examples of OpenAPI and AsyncAPI API contract files in the [`apis` folder of this repo](https://github.com/bump-sh/examples/tree/main/apis)
Expand All @@ -10,6 +12,10 @@ You can find all available examples of OpenAPI and AsyncAPI API contract files i

You can find all available examples of Hubs (or API Portals) of OpenAPI and AsyncAPI API contract files in the [`hubs` folder of this repo](https://github.com/bump-sh/examples/tree/main/hubs)

## View example Workflows and generated runners

You can find all available examples of Workflows of Flower or Arazzo contract files in the [`workflows` folder of this repo](https://github.com/bump-sh/examples/tree/main/workflows)

## What are these API contract files?

Most of them are publicly available API contract files from real tech companies and products.
Expand Down
8 changes: 8 additions & 0 deletions workflows/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Workflows examples

This directory holds [Flower](https://github.com/bump-sh/flower-spec) example Workflow files which can generate servers (REST & MCP endpoints) to run your always up-to-date workflows defined thanks to their Flower or [Arazzo](https://spec.openapis.org/arazzo/latest.html) definition file.

The files are automatically deployed to Bump.sh, You can test them live at:

- [Weather server](https://github.com/bump-sh/examples/blob/main/workflows/weather.yml): https://run.bump.sh/demo/weather/mcp

Loading