Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cucumber/polyglot-release
Make polyglot releases with a single command
https://github.com/cucumber/polyglot-release
bash polyglot-release
Last synced: about 1 month ago
JSON representation
Make polyglot releases with a single command
- Host: GitHub
- URL: https://github.com/cucumber/polyglot-release
- Owner: cucumber
- License: mit
- Created: 2022-04-07T18:06:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T14:23:38.000Z (11 months ago)
- Last Synced: 2024-04-14T13:08:33.888Z (7 months ago)
- Topics: bash, polyglot-release
- Language: Shell
- Homepage:
- Size: 157 KB
- Stars: 5
- Watchers: 120
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/cucumber/polyglot-release/actions/workflows/main.yml)
# polyglot-release
Make releases with a single command
Supports the release process for Cucumber repos as documented in [RELEASING.md](https://github.com/cucumber/.github/blob/main/RELEASING.md).
It's designed to be run locally on a dev's workstation to make the mechanical changes to package manager manifests and the `CHANGELOG.md` file neccesary when making a release.
Essentially, when you run `polyglot-release X.Y.Z` it will:
1. run some sanity checks to make sure you don't have unpushed local changes etc.
1. modify package manager files in each language version to set the next version to X.Y.Z
1. update the `CHANGELOG.md` moving everything in the `Unreleased` section into a section for the X.Y.Z release.
1. commit
1. tag the commit with `vX.Y.Z`
1. git push to a `release/vX.Y.Z` branch on the `origin` remote
4) modify package manager files in some languages (e.g. Java) to a "post-release / next development / SNAPSHOT" version
5) commit again
6) push everything to `origin/main`
## Works with polyglot repos
If we have a project structure with distinct folders for each language, it will release each language, updating the version number in the different package manager manifests in a single git commit.
```
$ tree
.
├── CHANGELOG.md
│── android
│ └── gradle.properties
│── c
│ └── VERSION
│── dotnet
│ ├── Project.sln
│ └── Project
│ └── Project.csproj
├── elixir
│ └── mix.exs
├── github-action
│ └── action.yml
├── go
│ └── go.mod
├── javascript
│ └── package.json
├── java
│ └── pom.xml
├── perl
│ ├── cpanfile
│ └── VERSION
├── php
│ └── composer.json
├── python
│ └── setup.py # or pyproject.toml
└── ruby
├── project.gemspec
└── VERSION
```
## Works with monoglot repos
If certain key files (`pom.xml`, `*.gemspec`, `package.json`, etc.) are present in the root directory, the project is assumed to be a "monoglot" repo and we just release that language.
```
$ tree
.
├── CHANGELOG.md
├── pom.xml
```
## Installation
First, check that `/usr/local/bin` is writable on your machine:
touch /usr/local/bin/polyglot-release
If this fails, you need to [make it writable](https://apple.stackexchange.com/questions/192227/how-to-make-files-in-usr-local-writable-for-homebrew)
To install in a project run:
```shell
POLYGLOT_RELEASE_VERSION=1.5.0
curl --silent -o /usr/local/bin/polyglot-release https://raw.githubusercontent.com/cucumber/polyglot-release/v$POLYGLOT_RELEASE_VERSION/polyglot-release
chmod 755 /usr/local/bin/polyglot-release
# Ensure /usr/local/bin is in your $PATH
polyglot-release --help
```
Before using `polyglot-release` to make a release, make sure you have these tools installed:
* [Git](https://git-scm.com/) - version > 2.25
* [changelog](https://github.com/cucumber/changelog/)
* `curl`
* `gpg`
* Core Utils (e.g. `find`, `sed`, `grep`, `pushd`, `popd`, ect). On MacOS you can install this with `brew install coreutils`
Other tools may also be required depending on the language(s) you are trying to release. Polyglot-release will inform
you about these as needed.
## Contributing
First, install [shellcheck](https://www.shellcheck.net/)
To run all the tests:
./polyglot-release-test
To run a single test:
./polyglot-release-test
We use an [approval testing](https://approvaltests.com/) style for testing this app.
Each test is a shell script in the [`tests`](./tests) folder. Alongside the test file you will find `.expected` files that show different kinds of expected outputs and effects from running the test script. If you've run the tests you will also find matching `.actual` files.
### Fixtures
When a test runs, we set up a temporary folder to run it in, with a `local` git repo and a remote `origin` repo (sitting in a folder right next to it). The `local` repo starts with an initial git commit with the contents of one of the [`tests/fixtures`](./tests/fixtures) folders. Use a header in your test script to specify the fixture to use (otherwise it will default to the `polyglot` fixture)
e.g.
```
# fixture: my-unique-setup
polyglot-release 1.0.0
```
### Exploratory testing
Sometimes it's helpful to play around with how the tool works in a safe, sandbox environment.
You can start a bash prompt in the same environment as an automated test would run in (with `local` and `origin` git repo folders) like this:
polyglot-release-test ./tests/fixtures/
## Releasing
You can use `polyglot-release` to release polyglot-release:
```
./polyglot-release MAJOR.MINOR.PATCH
```