Git Product home page Git Product logo

auto-changelog-release's Introduction

Repo-Experience

A continuous experiment testing various features the devops team can use with their daily workflow.

https://github.com/marketplace/actions/automated-releases

Automatic Release:

Github Actions Setup

The sample Github actions below watches for changes on the VERSION.txt and triggers a release when VERSION.txt is changed. To use this, make sure to create a Github Personal Access Token (PAT), and add it as a Repository Secret named REPOSITORY_TOKEN.

# Create a GitHub Actions workflow YAML file (e.g., main.yml) in the .github/workflows directory
# This workflow will run only on the main branch

name: Automatically Publish Release

on:
  pull_request:
    paths:
      - 'VERSION.txt'
    branches:
      - main
  push:
    paths:
      - 'VERSION.txt'
    branches:
      - main

jobs:
  set-secret-and-run-python:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Automated Releases
        uses: AnshKetchum/auto-changelog-release@alpha-1
        with: 
          GIT_PERSONAL_ACCESS_TOKEN: ${{ secrets.REPOSITORY_TOKEN }}

Daily Setup

  1. Maintain a CHANGELOG.md file

  2. Highlight your latest release by wrapping your entry with the following:

--LATEST-- YOUR CHANGELOG HERE --LATEST--

  1. Highlight your description by wrapping the description inside with the following:

--DESCRIPTION-- YOUR DESCRIPTION HERE --DESCRIPTION--

Example:

--LATEST--
## [1.20.0]
--DESCRIPTION--
- Removed unnecessary log statements from the GCC toolchain from popping up on Windows
--DESCRIPTION--
--LATEST--

Execution

In a .env file, add a personal access token from Github.

GITHUB_PERSONAL_ACCESS_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN>
  1. Install the requirements. pip install -r requirements.txt
  2. Run the python code. python create_release.py

auto-changelog-release's People

Contributors

anshketchum avatar

Stargazers

 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.