Skip to content
New issue

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

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

Already on GitHub? # to your account

Automatically create github release for tagged versions #332

Closed
wants to merge 1 commit into from

Conversation

Woazboat
Copy link
Contributor

@Woazboat Woazboat commented Dec 5, 2023

Use github actions to automatically create a release for versions tagged with v*.*.*

  • Build a docker image and upload to github container repository.
  • Upload pre-built binary as release artifact.

Currently based on Ubuntu 22.04 docker image

@mmd-osm
Copy link
Collaborator

mmd-osm commented Dec 5, 2023

As a heads up: This may probably not work since I’m only collaborator in this repo and cannot create personal access tokens or configure a GITHUB_TOKEN. That’s also the reason why I work mostly with my own fork, and create pull requests from there. As long as I’m working in my own repo, I don’t have that many restrictions.

@Woazboat
Copy link
Contributor Author

Woazboat commented Dec 5, 2023

I think it should work. Looking at https://github.com/zerebubuth/openstreetmap-cgimap/actions/runs/7079318119/job/19265821617#step:1:24 , the default authentication token does have package and content write permissions that are required for this.

@mmd-osm
Copy link
Collaborator

mmd-osm commented Dec 6, 2023

I think we need to double check this with zerebubuth, who owns the repo. While we might be able to publish packages, I have no way to control or manage them afterwards.

Also, we should check if publishing packages is really worth the extra effort and does not increase the overall maintenance effort. osm.org uses Ubuntu PPAs at the moment, OpenHistoricalMap is building their own Docker images, so both of our main "customers" would not see an immediate benefit.

I introduced Docker images mainly to have a bit more control on package dependencies when running unit tests. They could be also useful for some local testing. However, in general are not meant as is for production usage. Once we start publishing packages, people might have a different expectation, i.e. would expect a more "production like" image.

@Woazboat
Copy link
Contributor Author

Woazboat commented Dec 6, 2023

While we might be able to publish packages, I have no way to control or manage them afterwards.

Okay, then that's probably not a good idea.

Also, we should check if publishing packages is really worth the extra effort and does not increase the overall maintenance effort. osm.org uses Ubuntu PPAs at the moment, OpenHistoricalMap is building their own Docker images, so both of our main "customers" would not see an immediate benefit.

The main benefit of having prebuilt packages available would be for new users who want to quickly try out cgimap. Maybe that's not really worth it since that's a very limited target audience.

I introduced Docker images mainly to have a bit more control on package dependencies when running unit tests. They could be also useful for some local testing. However, in general are not meant as is for production usage. Once we start publishing packages, people might have a different expectation, i.e. would expect a more "production like" image.

We could also simply remove the docker image upload from the workflow and just have the automatic release creation (+ maybe the binary artifact).

@mmd-osm mmd-osm marked this pull request as draft January 6, 2024 15:32
@mmd-osm mmd-osm force-pushed the master branch 2 times, most recently from 141edd8 to 81e6a3a Compare January 10, 2024 18:15
@mmd-osm mmd-osm added the considering Not Actionable - still considering if this is something we want label Apr 24, 2024
@mmd-osm mmd-osm force-pushed the master branch 2 times, most recently from b766d6a to 3b6c868 Compare May 10, 2024 10:25
@mmd-osm
Copy link
Collaborator

mmd-osm commented Aug 14, 2024

Now with the discussion in #381 we could attach the build artifact to the new release, similar to how https://github.com/trstringer/azblogfilter/releases looks like.

In our case this would be single .deb file for amd64 and Debian 12, at least for now. I belive this could avoid some of issues with package registries for now.

@mmd-osm mmd-osm mentioned this pull request Aug 20, 2024
@mmd-osm
Copy link
Collaborator

mmd-osm commented Aug 23, 2024

I've included at least the softprops/action-gh-release based release process in #449 now. Thanks a lot for the PR!

@mmd-osm mmd-osm closed this Aug 23, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
considering Not Actionable - still considering if this is something we want
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants