Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitLab CI usage example to README.md #21

Closed
orhun opened this issue Oct 15, 2021 · 4 comments
Closed

Add GitLab CI usage example to README.md #21

orhun opened this issue Oct 15, 2021 · 4 comments
Assignees
Labels
feature/request New feature or request

Comments

@orhun
Copy link
Owner

orhun commented Oct 15, 2021

Is your feature request related to a problem? Please describe.
It would be nice to see an example in the documentation for the usage of git-cliff with GitLab CI.

Describe the solution you'd like
Add an example .gitlab-ci.yml to README.md, preferably after the github-action section.

Describe alternatives you've considered
None

Additional context
#20

@alteregoart
Copy link
Contributor

alteregoart commented Oct 15, 2021

changelog:
  image:
    name: orhunp/git-cliff:latest
    entrypoint: [""]
  stage: doc
  script:
    - git-cliff -r . > CHANGELOG.md
  artifacts:
    paths:
      - CHANGELOG.md 

I think this is the minimum configuration
@orhun

@alteregoart
Copy link
Contributor

and this solution work fine on this repo https://gitlab.com/alteregoart/git-cliff-test (on the docs.gitlab-ci.yml)

@orhun
Copy link
Owner Author

orhun commented Oct 17, 2021

and this solution work fine on this repo gitlab.com/alteregoart/git-cliff-test (on the docs.gitlab-ci.yml)

Awesome! Do you mind submitting a PR to add this example to README.md?

@alteregoart
Copy link
Contributor

Nope
I did, see #24

@orhun orhun closed this as completed Oct 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants