Skip to content

Commit aae4870

Browse files
authored
Merge pull request #220 from humanmade/update-deploy-instructions
Improve deploy instructions
2 parents e7b47db + 7e2a2d4 commit aae4870

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,15 @@ The process for releasing is:
121121
* Run `lerna publish` and add the new version number.
122122
* This will prompt you for a new version number and create & push new release commits and tags which will trigger Packagist to release a new version of the Composer package.
123123
* Run `./publish.sh` to push the standards for hm-linter
124-
* This will ask if you want to bump the latest version to the new version. Only do this for minor releases.
125-
* For major releases, publish a changelog to the Dev H2 (significant bugfixes may also warrant a post)
124+
* If you do not already have an AWS profile with access to the Linter Bot S3 bucket, make a request to the servers team for it before beginning this process.
125+
* If you use a non-default AWS profile for the Linter Bot, you can use `AWS_DEFAULT_PROFILE={name of AWS profile} ./publish.sh` instead.
126+
* This will ask if you want to bump the latest version to the new version. Only do this for patch releases.
127+
* To verify that the changes pushed correctly, you can run `aws s3 ls s3://hm-linter/standards/ --profile {name of AWS profile}`
128+
* For major and minor releases, publish a changelog to the Dev H2 (significant bugfixes may also warrant a post)
129+
* Publish a new release in the GitHub Release UI with the changes from CHANGELOG.md and update CHANGELOG.md with the release version and date.
130+
* After a cool-off period (typically one month), bump the latest version of the standards for Linter bot.
131+
* Checkout the Git tag for the release.
132+
* Verify that your local is clean of changes.
133+
* Run `./publish.sh` and bump `latest`.
126134

127135
If you're releasing a major version, you should also create a branch for the major version so that bugfix releases can be created. This branch should be a humanised name of the version; e.g. 0.4 would be `oh-dot-four`, 1.6 would be `one-dot-six`.

0 commit comments

Comments
 (0)