Code Monkey home page Code Monkey logo

release-note-generator's Introduction

release-note-generator

Required artifacts

your-repository/
└── .github/
    ├── scripts/
    │   ├── utils/
    │   │   └── utils.py
    │   ├── pr_validator.py
    │   └── releaser.py
    ├── workflows/
    │   ├── initiate-release.yaml
    │   ├── pr-validator.yaml
    │   └── releaser.yaml
    ├── pull_request_template.md
    ├── release_template.md
    └── release.yml

Required labels

Label Description
help Request for help on slack
ignore No need to include these pull requests in the GitHub release
release Automated pull request for a new release
type/breaking Pull Requests that mention breaking changes or deprecations
type/bugfix Pull requests for addressing a fix for a bug
type/chore Pull requests for addressing refactoring, documentation, etc
type/enhancement Pull requests suggesting improvements to an existing feature
type/feature Pull requests proposing the addition of a new feature

How to copy the artifacts to your repository?

  1. Clone this repository
$ git clone https://github.com/chandratop/release-note-generator.git
  1. Store the path to this repo in a variable
export RNG="/path/to/release-note-generator/.github/"
  1. Navigate to your repository
$ cd /path/to/your-repository
  1. Copy the necessary artifacts in your repository
rsync -av $RNG .github/
  1. To clone all the labels, first delete all the existing labels from the destination repo. Then run the following script which we copied in the previous step.
cd .github/scripts/
chmod +x copy-labels.sh
./copy-labels.sh <destination-repo-name> <destination-repo-name>

Replace new release tag in additional files

If you would like to perform additional tag replacements, go to .github/scripts/releaser.py and search for the following section and edit it.

#TODO: update any additional files with the new release tag
additional_files = ["releases.yaml"]

release-note-generator's People

Contributors

chandratop avatar actions-user avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.