Skip to content

Commit

Permalink
Move instructions on releasing to MAINTAINING.md (#286)
Browse files Browse the repository at this point in the history
  • Loading branch information
fsteeg committed Mar 7, 2023
1 parent 7904e50 commit ffa4a3d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
11 changes: 11 additions & 0 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Releasing

Create a release and packages on GitHub:

- Change the `version` in `build.gradle`: remove `-SNAPSHOT`
- Commit and tag that state (e.g. `git tag 0.4.0`), push the tag (e.g. `git push origin 0.4.0`)
- Push that state to the `publish` branch to create GitHub packages: `git push origin master:publish`
- Create a local runner distribution: `./gradlew distZip`
- Create a release on GitHub: https://github.com/metafacture/metafacture-fix/releases, choose the new tag
- Attach the runner zip from `metafacture-fix/metafix-runner/build/distributions`
- Update the `version` in `build.gradle`: increase number, add `-SNAPSHOT`
12 changes: 0 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,18 +109,6 @@ Run workflows on the web server, passing `data`, `flux`, and `fix`:

[http://localhost:8080/xtext-service/run?data='1'{'a': '5', 'z': 10}&flux=as-lines|decode-formeta|fix|encode-formeta(style="multiline")&fix=map(a,b) map(\_else)](http://localhost:8080/xtext-service/run?data=%271%27{%27a%27:%20%275%27,%20%27z%27:%2010}&flux=as-lines|decode-formeta|fix|encode-formeta(style=%22multiline%22)&fix=map(a,c)%20map(\_else))

## Releasing

Create a release and packages on GitHub:

- Change the `version` in `build.gradle`: remove `-SNAPSHOT`
- Commit and tag that state (e.g. `git tag 0.4.0`), push the tag (e.g. `git push origin 0.4.0`)
- Push that state to the `publish` branch to create GitHub packages: `git push origin master:publish`
- Create a local runner distribution: `./gradlew distZip`
- Create a release on GitHub: https://github.com/metafacture/metafacture-fix/releases, choose the new tag
- Attach the runner zip from `metafacture-fix/metafix-runner/build/distributions`
- Update the `version` in `build.gradle`: increase number, add `-SNAPSHOT`

## Functions and cookbook

### Best practices and guidelines for working with Metafacture Fix
Expand Down

0 comments on commit ffa4a3d

Please sign in to comment.