initial commit 🎉

.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release Chart
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: Helm chart release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Check out repository
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+
+      - name: Set up Git user
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      - name: Set up Helm
+        uses: azure/[email protected]
+        with:
+          version: v3.12.1
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        with:
+          skip_existing: true
+          mark_as_latest: true
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

CHANGELOG.rst

@@ -0,0 +1,25 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
+and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
+
+[0.1.0] - 2024-07-18
+--------------------
+
+Initial release of the Maintenance Chart.
+
+Added
+^^^^^
+
+- Basic Helm chart structure
+- Deployment for Caddy web server
+- ConfigMap for Caddyfile configuration
+- ConfigMap for HTML maintenance page
+- Service resource for the deployment
+- Ingress resource for external access
+- Customizable maintenance message and title via values.yaml
+- README.rst with installation and configuration instructions
+- AGPL License

CONTRIBUTING.rst

@@ -0,0 +1,98 @@
+Contributing
+============
+
+We welcome contributions to any of the charts!
+This document outlines the process for contributing to this project.
+
+Getting Started
+---------------
+
+1. Fork the repository on GitHub.
+2. Clone your fork locally:
+
+.. code-block:: bash
+
+    git clone https://github.com/codewithemad/helm-charts.git
+    cd helm-charts
+
+3. Create a new branch for your feature or bug fix:
+
+.. code-block:: bash
+
+    git checkout -b feature/your-feature-name
+
+Making Changes
+--------------
+
+1. Make your changes in your feature branch.
+2. Update or add tests as necessary.
+3. Update documentation, including `README.rst`_ and `CHANGELOG.rst`_, if applicable.
+4. Ensure your code follows the project's style and best practices.
+
+.. _README.rst: https://github.com/codewithemad/helm-charts/blob/master/README.rst
+.. _CHANGELOG.rst: https://github.com/codewithemad/helm-charts/blob/master/CHANGELOG.rst
+
+Testing Your Changes
+--------------------
+
+Before submitting a pull request, make sure to test your changes:
+
+1. Run the Helm linter:
+
+.. code-block:: bash
+
+    helm lint charts/<chart-dir>
+
+2. Perform a template rendering:
+
+.. code-block:: bash
+
+    helm template charts/<chart-dir>
+
+3. Do a dry-run installation:
+
+.. code-block:: bash
+
+    helm install --dry-run --debug test charts/<chart-dir>
+
+Submitting a Pull Request
+-------------------------
+
+1. Push your changes to your fork on GitHub:
+
+.. code-block:: bash
+
+    git push origin feature/your-feature-name
+
+2. Go to the original repository on GitHub and create a new Pull Request.
+3. Provide a clear description of the changes and reference any related issues.
+4. Submit the Pull Request for review.
+
+After Submitting
+----------------
+
+- Respond to any feedback on your Pull Request.
+- If requested, make additional commits to your branch and push them.
+- Once approved, your Pull Request will be merged into the main branch.
+
+Reporting Issues
+----------------
+
+If you find a bug or have a suggestion for improvement:
+
+1. Check if the issue already exists in the GitHub issue tracker.
+2. If not, create a new issue, providing as much relevant information as possible.
+
+Style Guide
+-----------
+
+- Follow the Helm best practices for chart development.
+- Use clear, descriptive commit messages.
+- Maintain consistent indentation and formatting.
+
+Questions?
+----------
+
+If you have any questions about contributing, feel free to ask in the issue tracker.
+
+Thank you for contributing!