From 05c95700b52572760fb2577a8e1d43da8eb47cfa Mon Sep 17 00:00:00 2001 From: "Paul B." Date: Fri, 3 Jul 2026 13:02:19 +0200 Subject: [PATCH] Add readme and automatic deploy for workflows --- .github/workflows/deploy.yml | 13 +++++++++++++ README.md | 6 ++++++ workflows/README.md | 8 ++++++++ 3 files changed, 27 insertions(+) create mode 100644 workflows/README.md diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index dc32d00..de572d0 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -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 diff --git a/README.md b/README.md index 2c17e26..9ad166f 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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. diff --git a/workflows/README.md b/workflows/README.md new file mode 100644 index 0000000..b7a14c6 --- /dev/null +++ b/workflows/README.md @@ -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 +