Sellsy Monorepo 🚀

Published at sellsy.docs.slsy.io

mindmap
  root((Sellsy Monorepo Documentation))
    Current_Project_Version
    Environments
      Localhost
      Review
      Staging
      Production
    Features
      Development environment
      Continuous_Integration_and_Delivery
        Automated_Pipelines
        Continuous_Deployment
      Infrastructure_as_Code_and_Configuration_Management
        GitOps_Practices
        Version_Control
        Infrastructure_as_Code
      Security
        Secrets_Management
      Documentation_and_Standards
        High-Quality_Documentation
        Coding_Standards

Overview 📚

Project version: 4.498.0

Welcome to the documentation for the Sellsy Monorepo! This repository integrates various modern DevOps tools and practices to streamline continuous integration (CI), continuous delivery (CD), and infrastructure management. This documentation aims to give a clear and concise guide for understanding, contributing to, and learning from the Sellsy Monorepo.

Environments 🌍

The Sellsy Monorepo supports and manages several environments, ensuring a smooth workflow from development to production:

Localhost: Development environment on your local machine.
Review: Environment for code review and testing.
Staging: Pre-production environment for final testing.
Production: Live environment where the application runs for end-users.

Features ✨

Development environment

Local development environment: Develop and simulate stack

Continuous integration and delivery

Automated pipelines: Seamless CI/CD pipelines using Gitlab CI/CD.
Continuous deployment: Automated deployments with a focus on reliability.

Infrastructure management and configuration management

Infrastructure as code: Manage infrastructure with Terraform FluxCD and kubernetes, using Helm and Kustomize for deployments.
gitops practices: Apply gitops with FluxCD for streamlined operations and deployments.
Version control: Use GitHub Flow for an efficient version control workflow.

Security

Secrets management: Manage secrets securely with SOPS.

Documentation and standards

High-quality documentation: Support comprehensive and high-quality documentation using mdBook and Vale.

Reference section

kubernetes documentation style guide
Diátaxis framework

Changelog 📝

This changelog file is automatically generated using semantic-release. It follows the Semantic Versioning (SemVer) standard and adheres to the Conventional Commits specification, specifically the Angular commit message convention.

Purpose 🎯

The changelog provides a structured and consistent format for documenting all notable changes made to the project. This includes new features, bug fixes, and other updates. By using semantic-release, we ensure that the versioning of the project is automated and follows the SemVer rules, ensuring compatibility and predictability for all users and developers.

Key Concepts 📚

Semantic Versioning (SemVer): A versioning scheme that uses a three-part version number (MAJOR.MINOR.PATCH) to convey meaning about the underlying changes.
- MAJOR version increments indicate incompatible API changes.
- MINOR version increments add functionality in a backward-compatible manner.
- PATCH version increments indicate backward-compatible bug fixes.
Conventional Commits (Angular): A convention for writing commit messages that include a type, a scope, and a description. This format allows semantic-release to automatically determine the version type to be released.
- feat: A new feature. 🚀
- fix: A bug fix. 🐛
- docs: Documentation only changes. 📚
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). 💅
- refactor: A code change that neither fixes a bug nor adds a feature. 🔄
- perf: A code change that improves performance. ⚡
- test: Adding missing or correcting existing tests. 🧪
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation. 🔧

Usage 🛠️

To generate a new release and update this changelog, ensure that your commits follow the Conventional Commits specification. The semantic-release tool will then analyze these commits to determine the type of version bump and update the changelog accordingly.

Name	Version
terraform	>= 1.3.7
scaleway	2.43.0

Name	Source	Version
briefcase_access_key_secret	../../../../../platforms/terraform-to-git-dotenv	n/a
briefcase_bucket	../../../../../platforms/scaleway/application-bucket	n/a
briefcase_endpoint_secret	../../../../../platforms/terraform-to-git-dotenv	n/a
briefcase_name_secret	../../../../../platforms/terraform-to-git-dotenv	n/a
briefcase_secret_key_secret	../../../../../platforms/terraform-to-git-dotenv	n/a
pdf_generator_access_key_secret	../../../../../platforms/terraform-to-git-dotenv	n/a
pdf_generator_bucket	../../../../../platforms/scaleway/application-bucket	n/a
pdf_generator_endpoint_secret	../../../../../platforms/terraform-to-git-dotenv	n/a
pdf_generator_name_secret	../../../../../platforms/terraform-to-git-dotenv	n/a
pdf_generator_secret_key_secret	../../../../../platforms/terraform-to-git-dotenv	n/a

Name	Description	Type	Default	Required
corp	n/a	`string`	n/a	yes
environment	n/a	`string`	n/a	yes
module_name	n/a	`string`	`"sellsy"`	no
organization_id	n/a	`string`	n/a	yes
project_id	n/a	`string`	n/a	yes
secrets_encryption	n/a	`bool`	n/a	yes
secrets_path	n/a	`string`	n/a	yes
unique_id	n/a	`string`	n/a	yes

Name	Version
terraform	>= 1.3.7
scaleway	2.43.0

Sellsy technical documentation

4.498.0 (2024-10-11)

4.497.0 (2024-10-11)

4.496.0 (2024-10-11)

4.495.0 (2024-10-11)

4.494.0 (2024-10-11)

4.493.0 (2024-10-11)

4.492.0 (2024-10-11)

4.491.2 (2024-10-10)

4.491.1 (2024-10-10)

4.491.0 (2024-10-10)

4.490.0 (2024-10-10)

4.489.3 (2024-10-10)

4.489.2 (2024-10-10)

4.489.1 (2024-10-10)

4.489.0 (2024-10-10)

4.488.1 (2024-10-10)

4.488.0 (2024-10-10)

4.487.1 (2024-10-09)

4.487.0 (2024-10-09)

4.486.0 (2024-10-09)

4.485.1 (2024-10-09)

4.485.0 (2024-10-09)

4.484.0 (2024-10-09)

4.483.0 (2024-10-09)

4.482.0 (2024-10-09)

4.481.2 (2024-10-09)

4.481.1 (2024-10-09)

4.481.0 (2024-10-09)

4.480.0 (2024-10-09)

4.479.0 (2024-10-08)

4.478.1 (2024-10-08)

4.478.0 (2024-10-08)

4.477.0 (2024-10-08)

4.476.2 (2024-10-08)

4.476.1 (2024-10-08)

4.476.0 (2024-10-08)

4.475.0 (2024-10-08)

4.474.0 (2024-10-08)

4.473.2 (2024-10-08)

4.473.1 (2024-10-08)

4.473.0 (2024-10-08)

4.472.1 (2024-10-08)

4.472.0 (2024-10-08)

4.471.1 (2024-10-08)

4.471.0 (2024-10-08)

4.470.0 (2024-10-08)

4.469.2 (2024-10-08)

4.469.1 (2024-10-08)

4.469.0 (2024-10-08)

4.468.0 (2024-10-08)

4.467.1 (2024-10-08)

4.467.0 (2024-10-08)

4.466.0 (2024-10-08)

4.465.2 (2024-10-08)

4.465.1 (2024-10-08)

4.465.0 (2024-10-08)

4.464.0 (2024-10-08)

4.463.1 (2024-10-08)

4.463.0 (2024-10-08)

4.462.0 (2024-10-08)

4.461.0 (2024-10-08)

4.460.0 (2024-10-07)

4.459.0 (2024-10-07)

4.458.0 (2024-10-07)

4.457.0 (2024-10-07)

4.456.0 (2024-10-07)

4.455.0 (2024-10-07)

4.454.0 (2024-10-07)

4.453.0 (2024-10-07)

4.452.0 (2024-10-07)