bg_image
header

Conventional Commits

Conventional Commits are a simple standard for commit messages in Git that propose a consistent format for all commits. This consistency facilitates automation tasks such as version control, changelog generation, and tracking changes.

The format of Conventional Commits follows a structured pattern, typically as:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Components of a Conventional Commit:

  1. Type (Required): Describes the type of change in the commit. Standard types include:

    • feat: A new feature or functionality.
    • fix: A bug fix.
    • docs: Documentation changes.
    • style: Code style changes (e.g., formatting) that don't affect the logic.
    • refactor: Code changes that neither fix a bug nor add features but improve the code.
    • test: Adding or modifying tests.
    • chore: Changes to the build process or auxiliary tools that don't affect the source code.
  2. Scope (Optional): Describes the section of the code or application affected, such as a module or component.

    • Example: fix(auth): corrected password hashing algorithm
  3. Description (Required): A short, concise description of the change, written in the imperative form (e.g., “add feature” instead of “added feature”).

  4. Body (Optional): A more detailed description of the change, providing additional context or technical details.

  5. Footer (Optional): Used for notes about breaking changes or references to issues or tickets.

    • Example: BREAKING CHANGE: remove deprecated authentication method

Example of a Conventional Commit message:

feat(parser): add ability to parse arrays

The parser now supports parsing arrays into lists.
This allows arrays to be passed as arguments to methods.

BREAKING CHANGE: Arrays are now parsed differently

Benefits of Conventional Commits:

  • Consistency: A uniform format for commit messages makes the project history easier to understand.
  • Automation: Tools can automatically generate versions, create changelogs, and even release builds based on commit messages.
  • Traceability: It becomes easier to track the purpose of a change, especially for bug fixes or new features.

Conventional Commits are especially helpful in projects using SemVer (Semantic Versioning) because they enable automatic versioning based on commit types.

 

 

 


Release Artifact

A Release Artifact is a specific build or package of software generated as a result of the build process and is ready for distribution or deployment. These artifacts are the final products that can be deployed and used, containing all necessary components and files required to run the software.

Here are some key aspects of Release Artifacts:

  1. Components: A release artifact can include executable files, libraries, configuration files, scripts, documentation, and other resources necessary for the software's operation.

  2. Formats: Release artifacts can come in various formats, depending on the type of software and the target platform. Examples include:

    • JAR files (for Java applications)
    • DLLs or EXE files (for Windows applications)
    • Docker images (for containerized applications)
    • ZIP or TAR.GZ archives (for distributable archives)
    • Installers or packages (e.g., DEB for Debian-based systems, RPM for Red Hat-based systems)
  3. Versioning: Release artifacts are usually versioned to clearly distinguish between different versions of the software and ensure traceability.

  4. Repository and Distribution: Release artifacts are often stored in artifact repositories like JFrog Artifactory, Nexus Repository, or Docker Hub, where they can be versioned and managed. These repositories facilitate easy distribution and deployment of the artifacts in various environments.

  5. CI/CD Pipelines: In modern Continuous Integration/Continuous Deployment (CI/CD) pipelines, creating and managing release artifacts is a central component. After successfully passing all tests and quality assurance measures, the artifacts are generated and prepared for deployment.

  6. Integrity and Security: Release artifacts are often provided with checksums and digital signatures to ensure their integrity and authenticity. This prevents artifacts from being tampered with during distribution or storage.

A typical workflow might look like this:

  • Source code is written and checked into a version control system.
  • A build server creates a release artifact from the source code.
  • The artifact is tested, and upon passing all tests, it is uploaded to a repository.
  • The artifact is then deployed in various environments (e.g., test, staging, production).

In summary, release artifacts are the final software packages ready for deployment after the build and test process. They play a central role in the software development and deployment process.