Skip to content

Commit 15d8e44

Browse files
committed
docs: Update README with automated release workflow
- Add release workflow badge - Document automated release process - Add commit message guidelines - Include development instructions
1 parent 3862c1d commit 15d8e44

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[![GitHub stars](https://img.shields.io/github/stars/PeterVinter/docker-safe-shutdown)](https://github.com/PeterVinter/docker-safe-shutdown/stargazers)
77
[![GitHub forks](https://img.shields.io/github/forks/PeterVinter/docker-safe-shutdown)](https://github.com/PeterVinter/docker-safe-shutdown/network)
88
[![CI](../../actions/workflows/ci.yml/badge.svg)](../../actions/workflows/ci.yml)
9+
[![Release](../../actions/workflows/release.yml/badge.svg)](../../actions/workflows/release.yml)
910
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/PeterVinter/docker-safe-shutdown/graphs/commit-activity)
1011
[![made-with-bash](https://img.shields.io/badge/Made%20with-Bash-1f425f.svg)](https://www.gnu.org/software/bash/)
1112
[![Docker Pulls](https://img.shields.io/docker/pulls/PeterVinter/docker-safe-shutdown)](https://hub.docker.com/r/PeterVinter/docker-safe-shutdown)
@@ -74,6 +75,57 @@ Logs are stored in:
7475
- `shutdowns_logs.txt`: Container shutdown logs
7576
- `shutdowned.txt`: Status of shutdown containers
7677

78+
## Development
79+
80+
### Automated Releases
81+
82+
This project uses GitHub Actions for automated releases. The workflow is triggered when a new tag is pushed and includes:
83+
84+
1. Automated Changelog Generation:
85+
- Generates changelog from commit messages
86+
- Includes commit hashes for reference
87+
- Groups changes by type
88+
89+
2. Quality Checks:
90+
- Runs ShellCheck on all scripts
91+
- Validates syntax and best practices
92+
- Ensures code quality before release
93+
94+
3. Release Creation:
95+
- Creates GitHub release automatically
96+
- Includes generated changelog
97+
- Adds feature list and installation instructions
98+
99+
To create a new release:
100+
101+
1. Make your changes and commit them:
102+
```bash
103+
git add .
104+
git commit -m "feat: your feature description"
105+
```
106+
107+
2. Create and push a new tag:
108+
```bash
109+
git tag -a v1.x.x -m "Release description"
110+
git push origin v1.x.x
111+
```
112+
113+
The workflow will automatically:
114+
- Generate the changelog
115+
- Run quality checks
116+
- Create the release
117+
- Update documentation
118+
119+
### Commit Messages
120+
121+
Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
122+
- `feat:` New features
123+
- `fix:` Bug fixes
124+
- `docs:` Documentation changes
125+
- `chore:` Maintenance tasks
126+
- `refactor:` Code improvements
127+
- `test:` Test updates
128+
77129
## Contributing
78130

79131
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.

0 commit comments

Comments
 (0)