Skip to content

Commit

Permalink
Add deployment steps (#1217)
Browse files Browse the repository at this point in the history
* Add deployment steps

* Move release docs to correct place

* Update CHANGELOG after release
  • Loading branch information
silvadenisaraujo authored Mar 28, 2024
1 parent 0491998 commit 8354db7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [4.0.5] - 2024-03-25

### Fixed

Expand Down
10 changes: 10 additions & 0 deletions docs/maintaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ This document is for people working on VTEX as Toolbelt maintainers.

### Deploying a new version

#### Continuous Delivery process

In order to automate the delivery process detailed in this section, there is a Github Action that can be used, just need to follow the steps below:

- Ensure the PR is passing the CI checks, is reviewed and approved
- Version bump in `package.json` following [SemVer](https://semver.org/)
- Create a new tag with the same version from previous step
- Push the code and tags and the release actions will start the process to deploy to NPM and AWS S3
- In the last step of the AWS release, it will open a PR to the repo responsible for the Homebrew update, [homebrew-vtex](https://github.com/vtex/homebrew-vtex), use the generated link and merge the PR to get it released in Homebrew as well.

#### **NPM**

The main deploy of `toolbelt` is on [NPM](https://www.npmjs.com/package/vtex). This deploy is reponsable for warning `new and deprecated versions`
Expand Down

0 comments on commit 8354db7

Please sign in to comment.