New Release (#51)

* fix

* docs: add release action to dev actions docs

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Checkout Source Code
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0 # Ensure full history is fetched
+          fetch-depth: 0
 
       - name: Sync with Remote
         run: |

README.md

@@ -96,6 +96,8 @@ We also got some additional features we thought about and couldn't implement yet
 
 - **Voting Timeframes**: Users creating a new vote can decide whether there's a start and end date for the votes.
 - **Multiple Options**: Users can also create votes where multiple options can be selected.
+- **Full Test Coverage**: We want to have full test coverage for the platform.
+- **Automated Testing**: We already have implemented some automated testing and linting, also in the `release.yml` action, where the app is automatically deployed. If we add full test coverage, we can also add automated testing to the deployment process (spec and e2e tests).
 
 # Contributing
 

docs/DEV_ACTIONS.md

@@ -33,3 +33,7 @@ ESLint on every pull request and alerts us if there are any errors.
 
 The greetings action is a simple action that sends a greeting message to the user that triggered the action. It is used
 to make the new contributors feel welcome and make them aware of the guidelines and best practices.
+
+## Release
+
+We have a fully automated release process that is triggered by a Github Action. The release process is based on the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. The action gets triggered when pushing the latest changes to `master` branch. It publishes a new Github release with the latest changes and updates the `CHANGELOG.md` file, also it publishes the new apps to our servers (Github Pages).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@votevault/source",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "scripts": {
     "prepare": "husky"