Skip to content

Commit 677082e

Browse files
committed
Add release instructions
1 parent 0c69683 commit 677082e

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Commons extension (name not final)
22
==================================
33

4-
This is a skeleton of OpenRefine extension for Wikimedia Commons, in the form of an independent Maven project.
4+
This is an OpenRefine extension for Wikimedia Commons.
55
It works with OpenRefine 3.6+.
66

77

88
Building it
99
-----------
1010

11-
Run
11+
Run
1212
```
1313
mvn package
1414
```
@@ -20,3 +20,15 @@ Developing it
2020

2121
To avoid having to unzip the extension in the corresponding directory every time you want to test it, you can also use another set up: simply create a symbolic link from your extensions folder in OpenRefine to the local copy of this repository.
2222
You will still need to restart OpenRefine every time you make changes.
23+
24+
Releasing it
25+
------------
26+
27+
- Open `pom.xml` and set the version to the desired version number, such as `<version>0.1.0</version>`
28+
- Commit and push those changes
29+
- Add a corresponding git tag, with `git tag -a v0.1.0 -m "Version 0.1.0"`
30+
- Push the tag to GitHub: `git push --tags`
31+
- Create the zip file for the release: `mvn package`
32+
- Create a new release on GitHub at https://github.com/OpenRefine/CommonsExtension/releases/new, providing a release title (such as "Commons extension 0.1.0") and a description of the features in this release. Upload the zip file you generated at the previous step as an attachment (it can be found in the `target` subfolder of your local copy of the repository).
33+
- Open `pom.xml` and set the version to the expected next version number, followed by `-SNAPSHOT`. For instance, if you just released 0.1.0, you could set `<version>0.1.1-SNAPSHOT</version>`
34+
- Commit and push those changes.

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<groupId>org.openrefine.extensions</groupId>
66
<artifactId>refine-commons-extension</artifactId>
7-
<version>0.1.0</version>
7+
<version>0.1.0-SNAPSHOT</version>
88
<packaging>jar</packaging>
99

1010
<name>OpenRefine - Commons extension</name>

0 commit comments

Comments
 (0)