faseengineering/commit-compiler repository overview

⁠CommitCompiler

A docker container package of the CommitCompiler⁠ project. This image is useful to create automated release and versioning documentation in a GitLab CI/CD pipeline.

⁠GitLab CI/CD

The application is built in a way to detect the environment variables GitLab passes to the docker container and use them for the generation of release documents. PAY ATTENTION: The workflow for CommitCompiler requires the pipeline to trigger on tags ONLY! For more information, please visit the GitHub Repository⁠. You can use the image in a pipeline like:

versioning:
  only:
    - tags
  stage: versioning
  image: faseengineering/commit-compiler:latest
  script:
    - |
      comcom --file "ReleaseNotes.md" --gitlab 
      set title="MyApplication", subtitle="What a beautiful one!", 
      website-url="https://example.com", website-alias="visit us"
  artifacts:
    paths:
      - release/

The results of comcom will be placed in the release/ directory, thus the job artifacts are specified here. If you want to test the application at first, you can change the command in the pipeline configuration for:

script:
  - comcom --example

which will generate a set of example files.