add companion hotfix doc (#4683)

* add companion hotfix doc

* Update CONTRIBUTING.md
This commit is contained in:
Mikael Finstad 2023-09-23 16:30:39 +08:00 committed by GitHub
parent 889653ebc6
commit 87a28ed18d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -178,6 +178,67 @@ Releases are managed by GitHub Actions, heres an overview of the process to r
If you dont have access to the transloadit.com source code ping @arturi or @goto-bus-stop and well pick it up. :sparkles:
### Releasing hotfix patch
#### Companion hotfix
First checkout the tag of the version you want to patch:
```bash
git checkout @uppy/companion@x.y.z
```
Now create a branch for your hotfix:
```bash
git checkout -b x.y.z-hotfix
```
Run yarn to make sure all packages are consistent:
```bash
corepack yarn
```
Now navigate to the Companion workspace:
```bash
cd packages/@uppy/companion
```
**Now cherry pick your desired commits**
Next edit `CHANGELOG.md` and then commit it:
```bash
git add CHANGELOG.md
git commit -m 'Update changelog'
```
Now let's create the version & tag
```bash
mkdir -p .git && npm version --workspaces-update=false --tag-version-prefix='@uppy/companion@' patch
```
Run a "dry-run" first:
```bash
corepack yarn pack
```
If the previous command succeeded, let's publish!
```bash
corepack yarn npm publish --access public --tag=none
```
Now we can push our branch and tags.
```bash
git push && git push --tags
```
#### Hotfix other packages
For other Uppy packages, the process should be similar to Companion,
but hasn't been documented yet. Make sure to remember to run `yarn` as well as building the package first, then you can release it.
If you do release any other packages, please update this doc.
## CSS guidelines
The CSS standards followed in this project closely resemble those from [Mediums CSS Guidelines](https://gist.github.com/fat/a47b882eb5f84293c4ed). If something is not mentioned here, follow their guidelines.