go-semantic-release / semantic-release

📦🚀 semantic-release written in Go
https://go-semantic-release.xyz
MIT License
395 stars 43 forks source link

doc: update the GitLab CI/CD example #152

Closed graugans closed 1 year ago

graugans commented 1 year ago

Without overwriting the entrypoint the job just silently does nothing which may lead to some frustration for the user.

Signed-off-by: Christian Ege ch@ege.io

graugans commented 1 year ago

As a side note how one can figure out what the latest release in this context is?

image: registry.gitlab.com/go-semantic-release/semantic-release:latest # Replace this with the current release

I was not able to find any official repository containing the Docker file for this image I guess this is the one: https://github.com/Nightapes/go-semantic-release/

christophwitzko commented 1 year ago

Hi @graugans, thanks for this PR.

The latest release can be found on the right side of the GitHub repository page:

Screenshot 2023-01-28 at 13 03 05

This also links to the releases overview, which lists all available versions. Nevertheless, in my opinion, the preferred way would be to use the latest tag.

The Dockerfile is located in the root folder of the project, and the image is built and published using goreleaser.

That's interesting; I was not even aware of a second go-semantic-release project 😅. However, I am not associated with this project.

christophwitzko commented 1 year ago

@cliedeman Would love to have your input if this example is correct 🙏

graugans commented 1 year ago

Hi @graugans, thanks for this PR.

The latest release can be found on the right side of the GitHub repository page: Screenshot 2023-01-28 at 13 03 05 This also links to the releases overview, which lists all available versions. Nevertheless, in my opinion, the preferred way would be to use the latest tag.

The Dockerfile is located in the root folder of the project, and the image is built and published using goreleaser.

That's interesting; I was not even aware of a second go-semantic-release project sweat_smile. However, I am not associated with this project.

Sorry I have overlooked it. Are there any plans for a documentation page?

christophwitzko commented 1 year ago

Hi @graugans,

I rebased your commit on the master branch: https://github.com/go-semantic-release/semantic-release/commit/a713764ef4c88541b56514218ffa59ba0d4a6a3e

Furthermore, I added a simple Go example application to the README.md: https://github.com/go-semantic-release/semantic-release#releasing-a-go-application-with-gitlab-ci

Are there any plans for a documentation page?

Yes, this is definitely on the roadmap, but I cannot say when it will happen.

Best, Chris

graugans commented 1 year ago

Perfect, thanks