Skip to content

Commit 14ebf8d

Browse files
committed
Improve Release instruction.
1 parent 3f07428 commit 14ebf8d

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

docs/ReleaseNewVersion.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,33 @@ Prior to tagging a release, ensure the following have been updated:
1414
to use the new major version. Any other version will automatically be used.
1515

1616
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).
17+
to get them reviewed and incorporated upstream, but **avoid merge commit**, use "Rebase and merge" instead).
1818

19-
Once all code and commits are in place and verified, to tag a release, use some commands like the following:
19+
Once all code and commits are in place and verified, you need to tag a release.
20+
21+
There are two options: you can tag `master` branch `HEAD` and push using commands:
2022

2123
```bash
22-
$ git tag -a 1.0.0 -m "Release version 1.0.0"
23-
$ git push origin 1.0.0
24+
$ git tag -a 3.1.0 -m "Release version 3.1.0"
25+
$ git push origin 3.1.0
2426
```
27+
Alternatively, you can use GitHub interface to tag: click "Draft a new release" and specify
28+
tag using the interface (you can leave title field empty, tag will be used as
29+
title in this case) and click "Publish release".
2530

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.
31+
In either option, when the tag is pushed or created via interface, travis will
32+
trigger a tag build that contains Deploy stage. At this stage it should
33+
automatically create the `moodle-plugin-ci.phar` release artifact and add it
34+
to the latest release "assets" on GitHub. Verify it has worked correctly by
35+
navigating at
36+
[Releases](https://github.com/moodlehq/moodle-plugin-ci/releases).
2837

29-
If there is any problem with that automatic deployment, the artifact will need to be created manually, follow these steps:
38+
If there is any problem with that automatic deployment, the artifact will need to be created manually. First build PHAR file manually:
3039

31-
- TODO
32-
- WIP
40+
```bash
41+
$ make build/moodle-plugin-ci.phar
42+
```
3343

44+
Once the above command suceeded, navigate to latest release in [GitHub
45+
interface](https://github.com/moodlehq/moodle-plugin-ci/releases), click
46+
"Edit" and attach generated PHAR file to release (you will find it at `./build` subdir).

0 commit comments

Comments
 (0)