Edit File by line

# Contributing

[0] Fix | Delete

[1] Fix | Delete

*Avoid sending detailed commits to the SVN Repo!* - Use the GIT repository to keep the detailed history and send to SVN only the "release" commit.

[2] Fix | Delete

[3] Fix | Delete

## Publishing New Releases

[4] Fix | Delete

[5] Fix | Delete

EmbedPress follows the [Semantic Versioning 2.0.0](http://semver.org), which means that given a version number we have `MAJOR`.`MINOR`.`PATCH`. We should increment these when:

[6] Fix | Delete

1. `MAJOR` version when we make incompatible API changes;

[7] Fix | Delete

2. `MINOR` version when we add functionality in a backwards-compatible manner;

[8] Fix | Delete

3. `PATCH` version when we make backwards-compatible bug fixes.

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

## Steps to publish a new release:

[12] Fix | Delete

1. [Update version on some files](https://github.com/OSTraining/EmbedPress/blob/master/CONTRIBUTING.md#1-updating-plugin-version);

[13] Fix | Delete

2. [Update changelog](https://github.com/OSTraining/EmbedPress/blob/master/CONTRIBUTING.md#2-updating-changelog);

[14] Fix | Delete

3. [Update branches](https://github.com/OSTraining/EmbedPress/blob/master/CONTRIBUTING.md#3-updating-branches);

[15] Fix | Delete

4. [Update GitHub tags/releases](https://github.com/OSTraining/EmbedPress/blob/master/CONTRIBUTING.md#4-updating-github-tagsreleases);

[16] Fix | Delete

5. [Generating a ready-to-install package](https://github.com/OSTraining/EmbedPress/blob/master/CONTRIBUTING.md#5-generating-a-ready-to-install-package);

[17] Fix | Delete

6. [Push changes to SVN](https://github.com/OSTraining/EmbedPress/blob/master/CONTRIBUTING.md#6-pushing-changes-to-svn).

[18] Fix | Delete

[19] Fix | Delete

[20] Fix | Delete

### 1. Updating plugin version

[21] Fix | Delete

- Make sure that all changes were already pushed to `development` branch;

[22] Fix | Delete

- Define the new [plugin version](https://github.com/OSTraining/EmbedPress/blob/master/CONTRIBUTING.md#publishing-new-releases);

[23] Fix | Delete

- Go to `/readme.txt` and look for the line/code below. Replace `x.x.x` with the new version.

[24] Fix | Delete

```

[25] Fix | Delete

Stable tag: x.x.x

[26] Fix | Delete

```

[27] Fix | Delete

- `/includes.php` - Look for the line/code below and replace `x.x.x` with the new version.

[28] Fix | Delete

```

[29] Fix | Delete

define('EMBEDPRESS_VERSION', "x.x.x");

[30] Fix | Delete

```

[31] Fix | Delete

- `/embedpress.php` - Look for the line/code below and replace `x.x.x` with the new version.

[32] Fix | Delete

```

[33] Fix | Delete

* Version: x.x.x

[34] Fix | Delete

```

[35] Fix | Delete

[36] Fix | Delete

### 2. Updating changelog

[37] Fix | Delete

All changelogs must follow the same format (using the Markdown syntax), which is:

[38] Fix | Delete

```

[39] Fix | Delete

= x.x.x =

[40] Fix | Delete

Release Date: YYYY-m-d

[41] Fix | Delete

[42] Fix | Delete

* foo;

[43] Fix | Delete

* another change/fix/enhancement;

[44] Fix | Delete

* list of what have changed.

[45] Fix | Delete

```

[46] Fix | Delete

Where `x.x.x` is the newest version and `YYYY-m-d` is the release date.

[47] Fix | Delete

[48] Fix | Delete

There's two files where the changelog must be updated with the latest changes: `/readme.txt` (look for the changelog section) and `/changelog.txt`.

[49] Fix | Delete

[50] Fix | Delete

### 3. Updating branches

[51] Fix | Delete

The `master` branch holds all released and production packages.

[52] Fix | Delete

[53] Fix | Delete

Once both version and changelog changes are ready and were already pushed to `development`, create a pull request from `development` to `master` branch.

[54] Fix | Delete

[55] Fix | Delete

### 4. Updating GitHub tags/releases

[56] Fix | Delete

After the pull request get approved, still on GitHub, go to Releases and [draft a new release](https://github.com/OSTraining/EmbedPress/releases/new).

[57] Fix | Delete

[58] Fix | Delete

- **Tag Version**: inform the version you just launched prefixed by a `v`.

[59] Fix | Delete

I.e: Let's say that the plugin was on version `1.4.2` and we patched something, hence the new version would be `1.4.3`. In this field, then, we'll put `v1.4.3`;

[60] Fix | Delete

- **Target**: for stable releases, this should always be `master`;

[61] Fix | Delete

- **Release Title**: the same value of **Tag Version**;

[62] Fix | Delete

- **Description**: The list (of changes) part of the version's changelog;

[63] Fix | Delete

- **Attach binaries**: we'll do on the next step.

[64] Fix | Delete

[65] Fix | Delete

### 5. Generating a ready-to-install package

[66] Fix | Delete

Now that everything seems to be updated:

[67] Fix | Delete

- Copy all plugin-only files (basically the whole `src` folder) into a separate directory (without .gitignore, etc);

[68] Fix | Delete

- Rename this "new" folder to `embedpress`. All lowercased.

[69] Fix | Delete

- Compress the folder into a `.zip` file;

[70] Fix | Delete

- Rename the `.zip` file to `embedpress-x.x.x.zip` - where you must replace `x.x.x` with the newest version;

[71] Fix | Delete

- Go to GitHub into your newest tag/release page (which you created on the previous step) and attach the `.zip` file to the form and save.

[72] Fix | Delete

[73] Fix | Delete

### 6. Pushing changes to SVN

[74] Fix | Delete

First, you must have the EmbedPress svn checked out somewhere in your machine. We'll call this local-mirror directory `svnDirectory`.

[75] Fix | Delete

[76] Fix | Delete

- Put the ready-to-install package contents (not the zip, only its content) into `svnDirectory/tags/x.x.x` where `x.x.x` is your release version;

[77] Fix | Delete

- Replace `svnDirectory/trunk` contents with the same files/package you just added to the tags folder;

[78] Fix | Delete

- Commit everything with a message announcing the new version, something like:

[79] Fix | Delete

```

[80] Fix | Delete

Releasing version x.x.x

[81] Fix | Delete

```

[82] Fix | Delete

Where `x.x.x` is the release version.

[83] Fix | Delete

[84] Fix | Delete