Skip to content
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.

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

feat: Add tap-shortcut and rename tap-clubhouse #959

Merged
merged 2 commits into from
Oct 25, 2022

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Oct 24, 2022

  • Adds tap-shortcut
  • Copies and updates settings for tap-clubhouse (envoy) to tap-shortcut
  • Deprecates tap-clubhouse (envoy) by applying hidden: true

Clubhouse was renamed to Shortcut a while ago and the existing tap is rather stale.

@netlify
Copy link

netlify bot commented Oct 24, 2022

Deploy Preview for meltano-hub ready!

Name Link
🔨 Latest commit cd3523e
🔍 Latest deploy log https://app.netlify.com/sites/meltano-hub/deploys/6357fe7bde26c600093b4b1b
😎 Deploy Preview https://deploy-preview-959--meltano-hub.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Oct 24, 2022

Testing plugin tap-clubhouse (envoy variant):

Starting test job...
...
Job completed.

Usage info
melty-bot % tap-clubhouse --help
usage: tap-clubhouse [-h] -c CONFIG [-s STATE]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Config file
  -s STATE, --state STATE
                        State file
Detected capabilities
  • ❌ 'discover'
  • ❌ 'catalog'
  • ❌ 'properties'
  • ✅ 'state'
  • ❌ 'about'

@github-actions
Copy link

github-actions bot commented Oct 24, 2022

Testing plugin tap-shortcut (envoy variant):

Starting test job...
...
Job completed.

Usage info
melty-bot % tap-shortcut --help
/home/runner/work/_temp/64d79d3b-99b2-4f9a-bcf4-19dbbc965816.sh: line 1: tap-shortcut: command not found
Detected capabilities
  • ❌ 'discover'
  • ❌ 'catalog'
  • ❌ 'properties'
  • ❌ 'state'
  • ❌ 'about'

@github-actions
Copy link

github-actions bot commented Oct 24, 2022

Testing plugin tap-shortcut (edgarrmondragon variant):

Starting test job...
...
Job completed.

Auto-generated README.md

tap-shortcut

Singer tap for Shortcut.

Built with the Meltano Singer SDK.

Capabilities

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening

Settings

Setting Required Default Description
token True None Shortcut Token
stream_maps False None Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config False None User-defined config values to be used within map expressions.
flattening_enabled False None 'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth False None The max depth to flatten schemas.

A full list of supported settings and capabilities is available by running: tap-shortcut --about

Version info
tap-shortcut v0.0.1, Meltano SDK v0.13.0
Usage info
melty-bot % tap-shortcut --help
Usage: tap-shortcut [OPTIONS]

  Execute the Singer tap.

Options:
  --state PATH              Use a bookmarks file for incremental replication.
  --catalog PATH            Use a Singer catalog file with the tap.
  --test TEXT               Use --test to sync a single record for each
                            stream. Use --test=schema to test schema output
                            without syncing records.
  --discover                Run the tap in discovery mode.
  --config TEXT             Configuration file location or 'ENV' to use
                            environment variables.
  --format [json|markdown]  Specify output style for --about
  --about                   Display package metadata and settings.
  --version                 Display the package version.
  --help                    Show this message and exit.
Detected capabilities
  • ✅ 'discover'
  • ✅ 'catalog'
  • ✅ 'state'
  • ✅ 'about'
JSON Metadata
{
  "name": "tap-shortcut",
  "description": "Singer tap for Shortcut.",
  "version": "0.0.1",
  "sdk_version": "0.13.0",
  "capabilities": [
    "catalog",
    "state",
    "discover",
    "about",
    "stream-maps",
    "schema-flattening"
  ],
  "settings": {
    "type": "object",
    "properties": {
      "token": {
        "type": [
          "string"
        ],
        "description": "Shortcut Token"
      },
      "stream_maps": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "description": "Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html)."
      },
      "stream_map_config": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "description": "User-defined config values to be used within map expressions."
      },
      "flattening_enabled": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "'True' to enable schema flattening and automatically expand nested properties."
      },
      "flattening_max_depth": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The max depth to flatten schemas."
      }
    },
    "required": [
      "token"
    ]
  }
}
Discovered streams
  • categories
  • epics
  • files
  • groups
  • iterations
  • labels
  • members
  • milestones
  • project_stories
  • projects
  • repositories
  • workflows

- Adds `tap-shortcut`
- Copies and updates settings for `tap-clubhouse` (envoy) to
  `tap-shortcut`
- Deprecates `tap-clubhouse` (envoy) by applying `hidden: true`
Copy link
Contributor

@pnadolny13 pnadolny13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@edgarrmondragon looks good to me!

@edgarrmondragon edgarrmondragon merged commit ddd78fd into main Oct 25, 2022
@edgarrmondragon edgarrmondragon deleted the feat/clubhouse-shortcut branch October 25, 2022 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants