Skip to content

Commit

Permalink
add some readme and context details
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanfkeepers committed Aug 26, 2022
1 parent 04e4e17 commit db1f5dd
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 5 deletions.
23 changes: 18 additions & 5 deletions .github/workflows/container.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
name: Publish Docker Container Images
on: push
# push:
# branches: [main]
# pull_request:
# branches: [main]
on:
push:
branches: [main]

env:
REGISTRY: ghcr.io
Expand All @@ -14,6 +12,21 @@ permissions:
packages: write

jobs:

# ------------------------------------------------------------------------------------------
# To be decided: Script-Deploy or Dockerfile-Deploy:
# Script:
# + Separates the golang build from the corso build.
# - Haven't figured out multiplatform builds yet.
# - Doesn't cache, always takes 10-15 minutes per build in the matrix.
# Dockerfile:
# + Once cached, takes <1m to deploy.
# + Multiplatform.
# + Extended features (such as tagging) can be handled by more github actions.
# - When not cached, can take >2 hours to build (at least initially).
# - Currently includes the complete golang:1.18 image.
# ------------------------------------------------------------------------------------------

Script-Deploy:
runs-on: ubuntu-latest
defaults:
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,18 @@ TODO - Link to the appropriate page in the published docs.
./build/build-container.sh
```

# Containers

Corso images are hosted on [ghrc.io](https://github.com/alcionai/corso/pkgs/container/corso).

Rolling release
```sh
# also builds linux/amd64
docker pull ghcr.io/alcionai/corso:rolling --platform linux/arm64
# alternative (also tags linux-amd64-rolling)
docker pull ghcr.io/alcionai/corso:linux-arm64-rolling
```

# Contribution Guidelines

TODO
Expand Down

0 comments on commit db1f5dd

Please sign in to comment.