https://github.com/naorlivne/drone-github-changelog-generator

a drone plugin version of https://github.com/github-changelog-generator/github-changelog-generator
https://github.com/naorlivne/drone-github-changelog-generator

Last synced: 10 days ago
JSON representation

a drone plugin version of https://github.com/github-changelog-generator/github-changelog-generator

• Host: GitHub
• URL: https://github.com/naorlivne/drone-github-changelog-generator
• Owner: naorlivne
• License: lgpl-3.0
• Archived: true
• Created: 2019-12-02T08:39:59.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-10T13:42:33.000Z (over 2 years ago)
• Last Synced: 2025-01-30T07:12:06.730Z (9 months ago)
• Language: Dockerfile
• Size: 26.4 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
> **Warning**

> Drone cloud stopped working for months and as the developers of Drone seemed to stop caring I'm no longer able to fully test this nor will I longer have any use of it, as a result I'm stopping all development of this plugin.

# drone-github-changelog-generator

CI/CD build status: [![Build Status](https://cloud.drone.io/api/badges/naorlivne/drone-github-changelog-generator/status.svg)](https://cloud.drone.io/naorlivne/drone-github-changelog-generator)

Drone plugin for deploying to [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator).

## Usage

This plugin can be used to create a changelog file based on GitHub tags, it will not auto-push it into the repo but rather create a changelog file for you to upload into your desired location via other Drone plugins.

The below pipeline configuration demonstrates simple usage:

```yaml

kind: pipeline

type: docker

name: default

steps:

- name: create_changelog

  image: naorlivne/drone-github-changelog-generator

  settings:

    github_user: naorlivne

    github_project: drone-github-changelog-generator

    output_path: CHANGELOG.md

```

## Parameter Reference

#### github_user

The GitHub user name which hosts the repo, can also use a GitHub organization name

#### github_project

The GitHub repo name

#### output_path

The changelog file path to be created, defaults to `CHANGELOG.md` in the current working directory (repo root by default).