Provide pre-built Docker images on Quay.io#1803
Conversation
40352de to
5de9fb6
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1803 +/- ##
============================================
- Coverage 71.02% 70.97% -0.06%
- Complexity 1645 1647 +2
============================================
Files 33 33
Lines 4314 4320 +6
============================================
+ Hits 3064 3066 +2
- Misses 1250 1254 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…is used. Loading the other one waits until the loading itself is working properly
…t folder and the if condition for the job is more open
ddf8bd0 to
a2c4c95
Compare
|
The instruction text will be added during the merge to the page Install Skosmos with Fuseki in Docker. Using Pre-built Docker ImagesYou can view the tags associated with Skosmos releases in its Quay.io repository. For more details about releases and their related tags, see our Releases page. TagsOur releases follow semantic versioning and we apply it on Quay.io as follows:
Pulling from Quay.ioYou can either pull the Docker image separately with |
osma
left a comment
There was a problem hiding this comment.
Looks like a good start, I gave some suggestions for cleanup
|
|
Good now, let's hope it works in main! I will merge this now |
Reasons for creating this PR
Sharing Docker images simplifies deployment processes, especially in automation as described in the issue: #1763.
Link to relevant issue(s), if any
Description of the changes in this PR
When the feature branch for this PR is merged into
main, every push, pull request and tagged release onmainwill publish latest Docker image to Quay.io. Instructions for using the Docker images will be added to the documentation (temporarly here).It would have been possible to create a separate issue for improving GitHub Actions logging, but since logging is needed throughout working on this PR, the improvements are included here together with the related changes.
Known problems or uncertainties in this PR
The "new" YAML code style may raise some “feelings” ;-), but in my view using two spaces for indentation before list markers is clearer and more elegant. This format is also accepted by YAML Lint.
Uploading Docker images to Quay.io is implemented in GitHub Actions as two workflows: pushes and pull requests trigger one workflow while pushing a tag triggers another (one may appear as “skipped” in the Actions UI but in practice they are separate workflows). All dependency causing tests must pass successfully before the Quay.io-related jobs are executed.
Progress was slowed down by timeouts in the
build-testjobs. The limit has been increased to 60 minutes. Personally, I would like this change to be merged intomain, but of course the matter is open for discussion.The code coverage tests, I did not consider them meaningful in the context of this issue.
Instruction for the reviewer:
Make a change to the
testfile.txtfile (located in the document root) and commit it. Also add a tag (git tag -a vN.N.N" -m "Test release version N.N.N") and push it (git push origin issue1763-pre-built-docker-images-for-public-use --tags). Monitor the GitHub Actions runs and finally verify the result inquay.io/natlibfi/skosmos. Try pulling the new image following the instructions.Checklist
Created a repository on Quay.io
Defined permissions
Configured GitHub Actions for both Docker images
Tested and verified functionality
Documentation complete
Reviewed / approved
Merge
phpUnit tests pass locally with my changes
I have added tests that show that the new code works, or tests are not relevant for this PR (e.g. only HTML/CSS changes)
The PR doesn't reduce accessibility of the front-end code (e.g. tab focus, scaling to different resolutions, use of
.sr-onlyclass, color contrast)The PR doesn't introduce unintended code changes (e.g. empty lines or useless reindentation)