https://github.com/pcvg/release-management
https://github.com/pcvg/release-management
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pcvg/release-management
- Owner: pcvg
- License: gpl-3.0
- Created: 2022-01-27T14:12:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-04T14:03:46.000Z (over 4 years ago)
- Last Synced: 2025-04-09T20:19:18.478Z (about 1 year ago)
- Language: Shell
- Size: 18.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Release management
Create a log of pushed commits and identify [ClickUp](https://clickup.com/) tickets related to merged branches.
## :gear: How does it work?
1. Pushed commits are verified and added along with their hash to the output log.
2. The commits related to merges are identified and it is checked if they have a respective ClickUp ticket.
3. The link of the identified tickets is added to the output log.
4. The `BODY_SUCCESS` variable is sent as env variable as the output of the action.
## :rocket: Running in GitHub Actions
Run this action in Github Actions by adding `pcvg/release-management@main` to your steps.
### Parameters
| Name | Meaning | Default | Required |
| --- | --- | --- | --- |
| `SUCCESS_MSG` | Top text of the message | Workflow completed. | true |
| `CLICKUP_KEY` | ClickUp API Access Key | - | true |
| `GH_EVENT_BEFORE` | ID of the previous workflow | ${{ github.event.before }} | true |
| `GH_SHA` | SHA of current commit | ${{ github.sha }} | true |
### Example
Example of integrating the output env var into a Slack notification.
```yml
name: Example
on:
push:
branches:
- main
jobs:
be-happy-workflow:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Run release management
uses: pcvg/release-management@test
with:
SUCCESS_MSG: "Deployment completed. :) "
- name: Notify on Slack
if: success()
uses: pcvg/slack-notification-action@main
with:
SLACK_WEBHOOK_URL: "https://hooks.slack.com/services/XXXX"
TITLE_SUCCESS: "Works!"
TITLE_FAIL: "Oh :( - Failed"
BODY_SUCCESS: ${{ env.BODY_SUCCESS }}
BODY_FAIL: "Deployment failed - Check https://github.com/${{ github.repository }}/commit/${{ github.sha }}/checks|${{ github.repository }}"
```
## ⚖️ License
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.