Skip to content

Add version table and update instructions. #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 22, 2019
Merged

Add version table and update instructions. #350

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
baad750
Add version table and update instructions.
dobooth May 9, 2019
3a7c942
Removed dupe upgrade instructions.
dobooth May 10, 2019
016332c
Updated title.
dobooth May 21, 2019
41f8039
Update docs/versioning.md
dobooth May 21, 2019
4929a59
Update docs/versioning.md
dobooth May 21, 2019
645eb05
Update docs/versioning.md
dobooth May 21, 2019
ca23a75
Merge branch 'develop' into db_version_table
dobooth May 21, 2019
40d16e6
Merge branch 'develop' into db_version_table
tomreece May 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion docs/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ X.Y.Z
| | +-- Backward Compatible changes (Patch release - bug fixes, small additions)
| +---- Backward Compatible changes (Minor release - small new features, bug fixes)
+------ Backward Incompatible changes (Major release - new features and/or major changes)

```

For example:
Expand All @@ -56,3 +55,32 @@ It MAY include patch level changes. Patch version MUST be reset to 0 when minor
Major version **X** MUST be incremented for a release that introduces backward incompatible changes.
A major release can also include minor and patch level changes.
You must reset the patch and minor version to 0 when you change the major version.

## MFTF version table
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section title doesn't describe its substance. The topic itself is about MFTF versioning and we see that it contains a table. The heading should give an idea of what is in that table.
Consider renaming to something like:
Relation to Magento releases

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.


This table lists the version of the MFTF that was released with a particular version of Magento.

|||
|---|---|
| Magento | MFTF |
| 2.3.1 | 2.3.13 |
| 2.3.0 | 2.3.9 |
| 2.2.8 | 2.3.13 |
| 2.2.7 | 2.3.8 |

## Updating MFTF
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a topic about MFTF update: https://devdocs.magento.com/mftf/docs/update.html
Shouldn't it go there?
By the way, the topic uses composer update to update dependencies. (This should be reviewed I believe because this command updates all Magento dependencies, not only MFTF).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.


The MFTF and the Magento product have differing release cycles, with the MFTF releasing more frequently. To get the latest version of the MFTF, update the version number in `composer.json` and update the package.

1. Open `composer.json` at the <Magento root>.
1. Find the MFTF listing:

```json
"require-dev": {
"friendsofphp/php-cs-fixer": "~2.13.0",
"lusitanian/oauth": "~0.8.10",
"magento/magento2-functional-testing-framework": "2.3.13",
```

1. Update the version number and save.
1. Run the `composer update` command.