From ffa4a3d83740783441d45654ffa2e6226f2d9599 Mon Sep 17 00:00:00 2001 From: Fabian Steeg Date: Tue, 7 Mar 2023 18:20:48 +0100 Subject: [PATCH] Move instructions on releasing to MAINTAINING.md (#286) --- MAINTAINING.md | 11 +++++++++++ README.md | 12 ------------ 2 files changed, 11 insertions(+), 12 deletions(-) create mode 100644 MAINTAINING.md diff --git a/MAINTAINING.md b/MAINTAINING.md new file mode 100644 index 00000000..9d0de2ef --- /dev/null +++ b/MAINTAINING.md @@ -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` diff --git a/README.md b/README.md index 6b503083..5adfdccc 100644 --- a/README.md +++ b/README.md @@ -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