packages/github/manifest.yaml

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
project:
    name: WhiskSystem
    packages:
        github:
            license: Apache-2.0
            version: 0.0.1
            public: true
            annotations:
                description: "Package which contains actions and feeds to interact with Github"
            actions:
                webhook:
                    version: 0.0.1
                    function: webhook.js
                    annotations:
                        feed: true
                        description: "Creates a webhook on GitHub to be notified on selected changes"
                        parameters: [
                            {
                                "name": "username",
                                "required": true,
                                "bindTime": true,
                                "description": "Your GitHub username"
                            },
                            {
                                "name": "repository",
                                "required": true,
                                "bindTime": true,
                                "description": "The name of a GitHub repository"
                            },
                            {
                                "name": "accessToken",
                                "required": true,
                                "bindTime": true,
                                "description": "A webhook or personal token",
                                "doclink": "https://github.com/settings/tokens/new"
                            },
                            {
                                "name": "events",
                                "required": true,
                                "description": "A comma-separated list",
                                "doclink": "https://developer.github.com/webhooks/#events"
                            },
                            {
                                "name": "baseUrl",
                                "required": false,
                                "description": "GitHub API endpoint",
                                "doclink": "https://docs.github.com/en/enterprise-server@2.21/rest/reference/enterprise-admin#endpoint-urls"
                            }
                        ]
                        sampleInput: {
                            "username": "myUserName",
                            "repository": "myRepository or myOrganization/myRepository",
                            "accessToken": "123ABCXYZ",
                            "events": "push, delete, pull-request",
                            "baseUrl": "https://github.myenterprise.com/api/v3"
                        }