Updated releasing.md and .gitattributes files.

jgebal · jgebal · commit c62d69ca50e8 · 2022-02-24T00:47:33.000+02:00
diff --git a/.gitattributes b/.gitattributes
@@ -1,17 +1,16 @@
+.github                   export-ignore
+.idea                     export-ignore
+development               export-ignore
+test                      export-ignore
 .gitattributes            export-ignore
 .gitignore                export-ignore
 .gitmodules               export-ignore
-.travis.yml               export-ignore
 mkdocs.yml                export-ignore
-.travis                   export-ignore
-.github                   export-ignore
 sonar-project.properties  export-ignore
-tests                     export-ignore
-development               export-ignore
-node_modules              export-ignore
-^docs/*                   linguist-documentation
+^docs/**                  linguist-documentation
 *.pkb                     linguist-language=PLSQL
 *.pks                     linguist-language=PLSQL
 *.sql                     linguist-language=PLSQL
 *.tpb                     linguist-language=PLSQL
 *.tps                     linguist-language=PLSQL
+*.sh		                  text eol=lf
diff --git a/development/releasing.md b/development/releasing.md
@@ -3,27 +3,28 @@
 To create a release follow the below steps
 
 ## Release preparation
-   - create a draft of Release from the `main` branch using [github releases page](https://github.com/utPLSQL/utPLSQL/releases) and populate release description using information found on the issues and pull requests **since previous release**.
+   - Create a **draft** of Release from the `main` branch using [github releases page](https://github.com/utPLSQL/utPLSQL/releases) and populate release description using information found on the issues and pull requests **since previous release**.
    To find issues closed after certain date use [advanced filters](https://help.github.com/articles/searching-issues-and-pull-requests/#search-by-open-or-closed-state). 
    Example: [`is:issue closed:>2018-07-22`](https://github.com/utPLSQL/utPLSQL/issues?utf8=%E2%9C%93&q=is%3Aissue+closed%3A%3E2018-07-22+)
 
 ## Performing a release
-   - create release branch from development branch and make sure to name the release branch: `release/vX.Y.Z`
-   - update, commit and push at least one file change in the release branch, to kick off a build on [GithubActions](https://github.com/utPLSQL/utPLSQL/actions) 
-   - wait for the build to complete successfully
+   - create the release branch from `develop` branch and make sure to name the release branch: `release/vX.Y.Z`
+   - update, commit and push at least one file change in the release branch, to kick off a build on [GithubActions](https://github.com/utPLSQL/utPLSQL/actions) or kick-off a build manually for that branch after it was created on github. 
+   - wait for the build to complete successfully as it will update the version to be release number (without develop)
    - merge the release branch to `main` branch and wait for build on `main` branch to complete successfully  (do not use Squash/rebase for merge operation)
-   - After A build was completed on a TAG (github release) was successful, merge main branch back into develop branch.
+   - Publish the release on the `main` branch and tag it with version number `vX.Y.Z`
+   - Wait for the release build to finish successfully on Github Actions as this will upload release artifacts (`zip` and `tar.gz` files along with `md5`) 
+   - After A Release build was completed successfully, merge main branch back into develop branch.
    - At this point, main branch and release tag should be at the same commit version and artifacts should be uploaded into Github release. 
-   - After develop branch was built, update version number in `VERSION` file to represent next planned release version.
+   - After develop branch was built, increase the version number in `VERSION` file to represent next planned release version.
    - Clone `utplsql.githug.io` project and add a new announcement about next version being released in `_posts`. Use previous announcements as a template. Make sure to set date, time and post title properly.
 
 The following will happen:
    - build executed on branch `release/vX.Y.Z-[something]` updates files `sonar-project.properties`, `VERSION` with project version derived from the release branch name
    - changes to those two files are committed and pushed back to release branch
-   - builds on main branch are **not getting executed**
-   - when a Github release is created, a new tag is added in on the repository and a tag build is executed
-   - the documentation for new release is published on `utplsql.github.io` and installation archives are added to the tag.
+   - when a Github release is published, a new tag is added in on the repository and a release build is executed
+   - With Release build, the documentation for new release is published on `utplsql.github.io` and installation archives are added to the release.
 
 # Note:
-The sources for release are provided in separate zip files delivered by the build process.
-The built zip files include HTML documentation generated from MD files.
+The utPLSQL installation files are uploaded by the release build process as release artifacts (separate `zip` and `tar.gz` files).
+The release artifacts include HTML documentation generated from MD files, sources and tests
