@coara/js-releases

$ update-changelog

Description

This script posts a changelog to ReadMe.com, capturing the latest updates from the service. Additionally, it attaches this information to the tour ticket details associated with each commit in the changelog.

To use this script you need to create a configuration file like the following:

{
    "bitbucket-host": "https://____.atlassian.net",
    "bitbucket-project": "XXX",
    "custom-properties": ["custom-1", "custom-2"]
}

$ update-changelog --bitbucket-user=$BITBUCKET_USER --bitbucket-api-token=$BITBUCKET_API_TOKEN --readme-api-key=$README_API_KEY --ci-project-name=$CI_PROJECT_NAME --ci-project-version=$CI_PIPELINE_ID

# Default CONFIG_PATH is ./changelog-config.json

$ upload-spec

Description

This script uploads or updates an OpenAPI/Swagger specification to ReadMe.com. If a specification with the same filename already exists, it will be updated; otherwise, a new specification will be created.

The filename is automatically generated from the swagger URL by combining the host and path components. Validation is performed to ensure the filename is valid for ReadMe.com.

$ upload-spec --apiKey=$README_API_KEY --apiVersion="1.0" --swaggerUrl="https://api.example.com/swagger.json"

# All parameters are required:
#   --apiKey, -k       ReadMe.com API key
#   --apiVersion, -v   API version in ReadMe.com
#   --swaggerUrl, -u   URL to OpenAPI/Swagger specification