mirror of
https://github.com/frappe/bench.git
synced 2025-01-23 15:08:24 +00:00
docs: Update releases information in README
This commit is contained in:
parent
357fcc0bbd
commit
dc197cf974
22
README.md
22
README.md
@ -35,6 +35,7 @@ Bench is a command-line utility that helps you to install, update, and manage mu
|
||||
- [Guides](#guides)
|
||||
- [Resources](#resources)
|
||||
- [Development](#development)
|
||||
- [Releases](#releases)
|
||||
- [License](#license)
|
||||
|
||||
|
||||
@ -254,6 +255,27 @@ $ pip3 install -U frappe-bench
|
||||
|
||||
To confirm the switch, check the output of `bench src`. It should change from something like `$HOME/bench-repo` to `/usr/local/lib/python3.6/dist-packages` and stop the editable install warnings from getting triggered at every command.
|
||||
|
||||
|
||||
## Releases
|
||||
|
||||
Bench's version information can be accessed via `bench.VERSION` in the package's __init__.py file. Eversince the v5.0 release, we've started publishing releases on GitHub, and PyPI.
|
||||
|
||||
GitHub: https://github.com/frappe/bench/releases
|
||||
|
||||
PyPI: https://pypi.org/project/frappe-bench
|
||||
|
||||
|
||||
From v5.3.0, we partially automated the release process using [@semantic-release](.github/workflows/release.yml). Under this new pipeline, we do the following steps to make a release:
|
||||
|
||||
1. Merge `develop` into the `staging` branch
|
||||
1. Merge `staging` into the latest stable branch, which is `v5.x` at this point.
|
||||
|
||||
This triggers a GitHub Action job that generates a bump commit, drafts and generates a GitHub release, builds a Python package and publishes it to PyPI.
|
||||
|
||||
The intermediate `staging` branch exists to mediate the `bench.VERSION` conflict that would arise while merging `develop` and stable. On develop, the version has to be manually updated (for major release changes). The version tag plays a role in deciding when checks have to be made for new Bench releases.
|
||||
|
||||
> Note: We may want to kill the convention of separate branches for different version releases of Bench. We don't need to maintain this the way we do for Frappe & ERPNext. A single branch named `stable` would sustain.
|
||||
|
||||
## License
|
||||
|
||||
This repository has been released under the [GNU GPLv3 License](LICENSE).
|
Loading…
x
Reference in New Issue
Block a user