Codecov Report

Merging #1357 (60bc5ff) into main (d90284c) will decrease coverage by 0.31%.
The diff coverage is 87.01%.

@@            Coverage Diff             @@
##             main    #1357      +/-   ##
==========================================
- Coverage   88.06%   87.74%   -0.32%     
==========================================
  Files         132      141       +9     
  Lines        5109     5679     +570     
  Branches     1207     1450     +243     
==========================================
+ Hits         4499     4983     +484     
- Misses        610      694      +84     
- Partials        0        2       +2     

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e5899dd...60bc5ff. Read the comment docs.

I previously missed that the Global services keyword is deprecated.

In general it might make more sense to make a property in the CiConfiguration Class for each of the properties in the Default interface (ex. defaultAfterScript) and reassemble everything in the renderCI method.

This would also give more flexibility in adding more methods to help the user configure these properties

  private renderCI() {
    return {
      default: { afterScript: this.defaultAfterScript, ... },
      include:
        this.include.length > 0 ? snakeCaseKeys(this.include) : undefined,
      pages: snakeCaseKeys(this.pages),
      services:
        this.services.length > 0 ? snakeCaseKeys(this.services) : undefined,
      variables:
        Object.entries(this.variables).length > 0 ? this.variables : undefined,
      workflow: snakeCaseKeys(this.workflow),
      stages: this.stages.length > 0 ? this.stages : undefined,
      ...snakeCaseKeys(this.jobs),
    };
  }
}

Just a few more small changes and I think this PR is about ready to ship 👍

On further thought, I'm not totally sure what the best practices are here regarding leaving class properties public or private, since this class is both like an L1 (not a lot of opinionated defaults) but also like an L2 (it some provides convenience methods). I want to say it probably makes sense to make most of the properties private by default so that they can be changed as needed in the future and make the class more L2-like, but I don't have a strong opinion on this.

@eladb do you have any guidance here?

My thoughts here were to make this closer to a L1, but with some private properties (with convenience methods) to prevent the creation of CI files with invalid field configurations.

In the future I would like something closer to the GithubProject (or what comes out of this RFC) where standard jobs are created for the different workflows that projen uses for GitHub (Release, build, etc). That future GitlabProject would probably have more private properties as it would be closer to a L3

Please read this to avoid merge hell

Hola! apologies for hassle. I've enabled Prettify as part of #1453. This means that most of the source files have changed and you will likely see quite a lot of merge conflicts when you try to merge from main.

But there's an easy way to handle this.

First, merge your branch from this tag:

$ git fetch origin
$ git merge 1020d0ad3f95bb4e1201f8640d440ffb43ccf230

Edit the .projenrc.js file in your branch and add this to line 57 (right
after codeCov: true):

  prettier: true,

Now, run:

$ git clean -fdx .
$ yarn
$ bash projen.bash
$ yarn eslint
$ git add .
$ git commit -m 'format code'

This will reformat all the code in your branch to match main.

Now, merge from main:

$ git merge origin/main

Sorry again for the inconvenience...