Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions .github/workflows/release-changelog-internal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,21 @@
name: changelog
permissions: write-all
on:
push:
push:
tags:
- "*"
- '*'
workflow_dispatch:
inputs:
tag:
required: true
type: string
description: "Enter the semantic version tag (eg: 2.3.2) for which you want to update the changelog"
jobs:
changelog:
uses: clouddrove/github-shared-workflows/.github/workflows/release-changelog.yml@master
uses: ./.github/workflows/release-changelog.yml
with:
branch: 'master'
branch: master
tag: ${{ inputs.tag || '' }}
secrets:
GITHUB: ${{ secrets.GITHUB }}
GITHUB: ${{ secrets.GITHUB }}
...
17 changes: 10 additions & 7 deletions .github/workflows/release-changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ on:
branch:
required: true
type: string
tag:
required: false
type: string
default: ''
secrets:
GITHUB:
required: true
Expand All @@ -29,26 +33,25 @@ jobs:
token: ${{ secrets.GITHUB }}
excludeTypes: ""
includeInvalidCommits: false
tag: ${{ github.ref_name }}

tag: ${{ inputs.tag != '' && inputs.tag || github.ref_name }}
- name: πŸš€ Create Release
uses: ncipollo/release-action@v1.16.0
with:
allowUpdates: true
draft: false
makeLatest: true
name: ${{ github.ref_name }}
# owner: clouddrove-ci
name: ${{ inputs.tag != '' && inputs.tag || github.ref_name }}
tag: ${{ inputs.tag != '' && inputs.tag || github.ref_name }}
body: ${{ steps.changelog.outputs.changes }}
token: '${{ secrets.GITHUB }}'
token: ${{ secrets.GITHUB }}

- name: βœ… Commit CHANGELOG.md
uses: stefanzweifel/git-auto-commit-action@v7
with:
branch: ${{ inputs.branch}}
branch: ${{ inputs.branch }}
commit_user_name: clouddrove-ci # defaults to "github-actions[bot]"
commit_user_email: 84795582+clouddrove-ci@users.noreply.github.com # defaults to "41898282+github-actions[bot]@users.noreply.github.com"
commit_author: CloudDrove CI <84795582+clouddrove-ci@users.noreply.github.com>
commit_message: 'docs: update CHANGELOG.md for ${{ github.ref_name }}'
file_pattern: CHANGELOG.md
...
...
37 changes: 37 additions & 0 deletions docs/relesae-changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Changelog
Changelog = human-readable summary of changes in each version of your project

## Usage
This release-changelog.yml workflow updates your Release page by categorizing changes into Fix, Feat, Docs, Tests, etc. An example release page can be found here: [2.1.1](https://github.com/clouddrove/github-shared-workflows/releases/tag/2.1.1).
- This workflow is automatically triggered when a release tag is created in the GitHub repository.
- You can also trigger it manually by providing an existing release tag version to update its Release page.

## Example
When running manually, you need to provide existing repository release tag name. [eg: 2.1.1]

####
```yaml
name: changelog
permissions: write-all
on:
push:
tags:
- '*'
workflow_dispatch:
inputs:
tag:
required: true
type: string
description: "Enter the semantic version tag (eg: 2.3.2) for which you want to update the changelog"
jobs:
changelog:
uses: clouddrove/github-shared-workflows/.github/workflows/release-changelog.yml@v2
with:
branch: master
tag: ${{ inputs.tag || '' }}
secrets:
GITHUB: ${{ secrets.GITHUB }}
```



Loading