diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..312781d --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,21 @@ +# Releases steps + +1. Checkout `origin/main`. +2. Update the `CHANGELOG.md` file with the changes of this release (the format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + * Copy the template for the next unreleased version at the top. + * Rename the previous unreleased version to the new version. +3. Update the version in `gradle.properties` and remove the `-SNAPSHOT` suffix. +4. Commit the changes, create a tag and push it: + ``` + git commit -am "Releasing 0.1.0." + git tag 1.0.0 + git push && git push --tags + ``` +5. Run the `release` github action to publish the release to maven. +6. Create a new release on GitHub with the same tag and write release notes. +7. Update the version in `gradle.properties` and add the `-SNAPSHOT` suffix. +8. Commit the change and push it: + ``` + git commit -am "Prepare next development version." + git push + ``` diff --git a/buildDocs.sh b/buildDocs.sh index 4d7617a..e0695a3 100755 --- a/buildDocs.sh +++ b/buildDocs.sh @@ -23,5 +23,5 @@ cp CHANGELOG.md $DOCS_ROOT/changelog.md cp LICENSE.md $DOCS_ROOT/license.md cp CODE_OF_CONDUCT.md $DOCS_ROOT/code-of-conduct.md -sed $SEDOPTION -e 's/LICENSE.md/license/' $DOCS_ROOT/index.md -sed $SEDOPTION -e 's/docs\/\([a-zA-Z-]*\).md/\1/' $DOCS_ROOT/index.md +sed $SEDOPTION -e 's/LICENSE.md/license/g' $DOCS_ROOT/index.md +sed $SEDOPTION -e 's/docs\/\([a-zA-Z-]*\).md/\1/g' $DOCS_ROOT/index.md diff --git a/docs/navigation.md b/docs/navigation.md index f5d8843..5507af0 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -191,9 +191,9 @@ dependencies { ## Limitations -!!! warning This library does not support restoring the state of the navigation stack when the -application is killed and restarted on android. This is a known limitation and is not planned to be -implemented in the future. +!!! warning + This library does not support restoring the state of the navigation stack when the application is killed and restarted on android. + This is a known limitation and is not planned to be implemented in the future. `Podfile`