Skip to content

Commit 2ffc40e

Browse files
committed
add a release guide to DEVELOPMENT.md
1 parent 1ffd967 commit 2ffc40e

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

DEVELOPMENT.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,38 @@
1-
### Internal Glossary
1+
# Release Guide
22

3-
#### `value_set`
3+
## `htmlburger/carbon-fields`
4+
5+
1. Merge all changes for the new version into `master`
6+
1. Bump version numbers in `config.php` and `package.json` according to SemVer
7+
1. Commit bumped version changes to `master`
8+
1. Checkout `release`
9+
1. Merge `master` into `release`. NEVER merge `release` into any other branch - only merge branches INTO `release`.
10+
1. Run `npm install && npm run build`
11+
1. You should now have changes ONLY in the /assets/dist/ directory - any changes outside this directory mean that you have a dirty working copy. Never commit anything else into `release` except /assets/dist/ changes.
12+
1. Commit the /assets/dist/ changes to `release`
13+
1. `git push --all`
14+
1. Create a new release in [Github](https://github.com/htmlburger/carbon-fields-plugin/releases/new) from the `release` branch
15+
1. Enter the new version you set in `config.php` for `Tag version` and `Title`
16+
1. Add a changelog for `Description`
17+
1. Click `Publish release`
18+
19+
## `htmlburger/carbon-fields-plugin`
20+
21+
1. Update the version in `carbon-fields-plugin.php` and `composer.json` for `htmlburger/carbon-fields` to match the newly released version
22+
1. Commit to `master`
23+
1. Create a new release in [Github](https://github.com/htmlburger/carbon-fields-plugin/releases/new) from the `release` branch
24+
1. Enter the new version for `Tag version` and `Title` (you can skip the changelog)
25+
1. Click `Publish release`
26+
27+
# Internal Glossary
28+
29+
## `value_set`
430

531
Represents a single field value. `Complex_Field` uses a `value_tree` instead which contains a `value_set` for every child field including the `Complex_Field` itself.
632

733
_Note: The `Value_Set` class will always return a fully formatted `value_set` with all of it's properties OR `null`_
834

9-
##### Schema
35+
### Schema
1036

1137
array(
1238
array(

0 commit comments

Comments
 (0)