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

Reorganize grist docker images and workflows #988

Merged
merged 6 commits into from
Jun 26, 2024
Merged

Conversation

jordigh
Copy link
Contributor

@jordigh jordigh commented May 17, 2024

My commit messages:

  • 12d4d61
    build.sh: add some diagnostic output

As I was testing, I found it useful to see when I was using the ext/
directory or not.

  • c5bb86f
    .grist-ee-version: start referencing the intended enterprise version

Since we won't be tracking ext/-directory providers via git (e.g. no
submodules), instead we'll do little version-tracking files like this,
to be used by the recent ext-checkout script.

  • 1374d83
    checkout-ext-directory: new helper script

This is just a helper script to get the ext directory of other grist
repos, currently intended for grist-ee.

  • 2c941d1
    tsconfig-ext: add /app, /test, and /stubs/app directories

This is so that they get built and tested, as we'll start running
tests on the ext/ directories from now on.

  • 7ae5f19
    workflows: build the grist-oss, grist, and grist-ee images

This modifies the workflow to build grist-ee images as well as grist,
which is the same image as grist-ee but merely renamed. The original
image built by these workflows is now called grist-oss.

  • 18058f8
    README: Mention the two possible docker images

@jordigh jordigh force-pushed the jordigh/grist-ee branch 4 times, most recently from 152e651 to da2aaa0 Compare May 23, 2024 22:43
@jordigh jordigh force-pushed the jordigh/grist-ee branch 2 times, most recently from b84bbee to d1613d5 Compare June 3, 2024 01:26
As I was testing, I found it useful to see when I was using the ext/
directory or not.
This is so that they get built and tested, as we'll start running
tests on the ext/ directories from now on.
@jordigh jordigh force-pushed the jordigh/grist-ee branch 3 times, most recently from d0b20f7 to 0197821 Compare June 19, 2024 19:30
@jordigh jordigh marked this pull request as ready for review June 19, 2024 19:33
@paulfitz paulfitz self-requested a review June 20, 2024 15:21
Copy link
Member

@paulfitz paulfitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great and organized just as I hoped for. Small comment about a file location.

We need to do a bunch of communication about this change. Here is what I believe is changing, spelling it out just to get it clear:

  • The grist-core source code is entirely free and open source.
  • The docker image gristlabs/grist is now built from grist-core PLUS some extensions that are source-available, and not free and open source. Inclusion of those extensions is new.
  • A docker container running gristlabs/grist will not use those extensions unless an administrator takes an action, such as providing an activation key.
  • Switching on extensions would be an action taken by an administrator, and not by general users. If an administrator has not enabled extensions, the experience of the all users should be exactly as it would be if the extensions were not included in the build.

The purpose of this change is so that self-hosters can choose to use services from Grist Labs, or stop using such services, without needing to rework their installation. From a business perspective, we plan to make hybrid hosting easy, where some services such as the formula assistant or end-to-end-encrypted snapshots are simple to offload to Grist Labs to administer if it suits a self-hoster to do so.

We will maintain an image gristlabs/grist-oss which does not contain extensions, for those who prefer that and are not interested in any services Grist Labs may offer, now or in the future.

@jordigh I'd like to see text about this in the README somewhere, and a very short summary and pointer to where to get more information in the workflow yml files.

.grist-ee-version Outdated Show resolved Hide resolved
@paulfitz
Copy link
Member

@fflorent @vviers I'd appreciate your eyes on this change, first of all on getting it clearly described, and then on the actual nature of the change.

Since we won't be tracking ext/-directory providers via git (e.g. no
submodules), instead we'll do little version-tracking files like this,
to be used by the recent ext-checkout script.
This is just a helper script to get the ext directory of other grist
repos, currently intended for grist-ee.
@jordigh jordigh force-pushed the jordigh/grist-ee branch 2 times, most recently from 88952a8 to 840d807 Compare June 20, 2024 20:41
This modifies the workflow to build grist-ee images as well as grist,
which is the same image as grist-ee but merely renamed. The original
image built by these workflows is now called grist-oss.
@jordigh
Copy link
Contributor Author

jordigh commented Jun 21, 2024

@paulfitz I've added a short draft in the README that explains some of the points you outlined above. As we don't yet have a story on how to turn on grist-ee, I am not explaining that yet.

As to being public and vocal that this change happened, I assume that's newsletter material?

Eventually once it all has settled, I think this distinction should go in the help website with both README and docker yaml files linking to the docs website.

README.md Outdated Show resolved Hide resolved
.github/workflows/docker_latest.yml Outdated Show resolved Hide resolved
@jordigh jordigh force-pushed the jordigh/grist-ee branch 2 times, most recently from 18058f8 to c6ce09f Compare June 26, 2024 14:50
Copy link
Member

@paulfitz paulfitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jordigh !

@paulfitz paulfitz changed the title Move grist-ee build into grist-core Reorganize grist docker images and workflows Jun 26, 2024
@jordigh jordigh merged commit 8cd9e40 into main Jun 26, 2024
13 checks passed
@jordigh jordigh deleted the jordigh/grist-ee branch June 26, 2024 19:19
@vviers
Copy link
Sponsor Collaborator

vviers commented Jun 27, 2024

Sorry for being late on reviewing this — thanks for the detailed explanation — this looks OK to us :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants