Skip to content

Commit 5817c6e

Browse files
committed
Complete the release docs with some important details
- what to change. - how to apply those changes. - when to tag. - what to expect after pushing tags. - how to proceed if the automatic "deploy" fails.
1 parent b5e2dd4 commit 5817c6e

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/ReleaseNewVersion.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,21 @@ Prior to tagging a release, ensure the following have been updated:
1313
* If this is a new major version, then the `.travis.dist.yml` and `doc/TravisFileExplained.md` need to be updated
1414
to use the new major version. Any other version will automatically be used.
1515

16-
As of writing this, releases are made from the `master` branch. To tag a release, use a commands like the following:
16+
When all the changes above have been performed, push them straight upstream to `master` (or create a standard PR
17+
to get them reviewed and incorporated upstream, **without merge commits** better).
18+
19+
Once all code and commits are in place and verified, to tag a release, use some commands like the following:
1720

1821
```bash
1922
$ git tag -a 1.0.0 -m "Release version 1.0.0"
2023
$ git push origin 1.0.0
21-
```
24+
```
25+
26+
When the tag is pushed, travis should automatically proceed to create the `moodle-plugin-ci.phar` release artifact
27+
and add it to the release files. Verify it has worked ok.
28+
29+
If there is any problem with that automatic deployment, the artifact will need to be created manually, follow these steps:
30+
31+
- TODO
32+
- WIP
33+

0 commit comments

Comments
 (0)