Skip to content

Commit

Permalink
add more releasing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jesus89 committed Jul 2, 2024
1 parent a59f9b0 commit 7ba2973
Showing 1 changed file with 39 additions and 5 deletions.
44 changes: 39 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,45 @@ versions of Raster Loader.

## Releasing

1. Create and merge a release PR `release/X.Y.Z` updating the CHANGELOG.md file
### 1. Create and merge a release PR updating the CHANGELOG

Title: `Release vX.Y.Z`
Description: CHANGELOG release notes
- Branch: `release/X.Y.Z`
- Title: `Release vX.Y.Z`
- Description: CHANGELOG release notes

2. Create and push a tag `vX.Y.Z`
Example:
```
## [0.7.0] - 2024-06-02
### Added
- Support raster overviews (#140)
### Enhancements
- increase chunk-size to 10000 (#142)
### Bug Fixes
- fix: make the gdalwarp examples consistent (#143)
```

### 2. Create and push a tag `vX.Y.Z`

This will trigger an automatic workflow that will publish the package at https://pypi.org/project/raster-loader.

This will trigger an automatic workflow that will create the release and publish the package.
### 3. Create the GitHub release

Go to the tags page (https://github.com/CartoDB/raster-loader/tags), select the release tag and click on "Create a new release"

- Title: `vX.Y.Z`
- Description: CHANGELOG release notes

Example:
```
### Added
- Support raster overviews (#140)
### Enhancements
- increase chunk-size to 10000 (#142)
### Bug Fixes
- fix: make the gdalwarp examples consistent (#143)
```

0 comments on commit 7ba2973

Please sign in to comment.