provide ci and container image #3431

kaiehrhardt · 2022-12-06T00:21:17Z

Description

TODOs:

arm64 build (https://app.circleci.com/pipelines/github/kaiehrhardt/commitlint/2/workflows/c709abf7-ca27-4f3c-b34f-7b7b658b5925/jobs/3 https://github.com/nodejs/docker-node/blob/main/docs/BestPractices.md#node-gyp-alpine)
remove commented workflow lines
multistage docker -> need some help here
use package/dist management -> need some help here
add tag build triggers
use tag build triggers
add docs
fix commit message

Maintainer TODO:

add service acc credentials for ghcr to circleci ($USER $PASS)

Motivation and Context

#3423

Usage examples

please refer docs

How Has This Been Tested?

ci test run https://app.circleci.com/pipelines/github/kaiehrhardt/commitlint

Types of changes

New feature (non-breaking change which adds functionality)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
All new and existing tests passed.

kaiehrhardt · 2022-12-08T00:27:03Z

@AdeAttwood @escapedcat @shanduur

kaiehrhardt · 2022-12-13T14:17:13Z

What else do i need to get into production?

AdeAttwood · 2023-01-12T20:40:08Z

Thanks for this, and sorry it's take me so long to get to it. I can defo pick this up and finish off all the internal commitlint stuff. I have created a docker hub account to push this to and set up the circle ci our end. I do have some queries about the docker file.

We should be using node:18-buster as the base image. This has a newer version of git installed in it that is used for trailers in some rules.
There needs to be a lot more packages built than @commitlint/cli and @commitlint/config-conventional. If we only package and install these, then all the decencies of @commitlint/cli get installed from npm. This will cause issues with packages like @commitlint/types being out of sync with the CLI package.
Do we really want to me setting the entrypoint of the image. I think this will only cause issues when trying to use this in CI environment. I think it will also need to be reset in GitHub action, like you have done in the docs.

This is the Dockerfile I have been looking at, heavily inspired by yours.

Dockerfile

FROM node:18-buster AS builder

WORKDIR /src

COPY . ./

RUN yarn install && yarn build

# Commit lint CLI packages
RUN npm pack @commitlint/cli
RUN npm pack @commitlint/config-validator
RUN npm pack @commitlint/ensure
RUN npm pack @commitlint/execute-rule
RUN npm pack @commitlint/format
RUN npm pack @commitlint/is-ignored
RUN npm pack @commitlint/lint
RUN npm pack @commitlint/load
RUN npm pack @commitlint/message
RUN npm pack @commitlint/parse
RUN npm pack @commitlint/read
RUN npm pack @commitlint/resolve-extends
RUN npm pack @commitlint/rules
RUN npm pack @commitlint/to-lines
RUN npm pack @commitlint/top-level
RUN npm pack @commitlint/types

# Default commitlint config
RUN npm pack @commitlint/config-conventional

FROM node:18-buster

COPY --from=builder /src/*.tgz ./

RUN npm install -g *.tgz

RUN rm ./*.tgz

I think the next steps for this is for me to take this branch and bring it under the commitlint repo. This way, we will be able to use the docker credentials to test pushing on a separate branch. Is that OK with you?

kaiehrhardt · 2023-02-16T14:45:30Z

Same here, sorry for my late response.

I have created a docker hub account to push this to and set up the circle ci our end.

Why, just use ghcr like i did?!

We should be using node:18-buster as the base image. This has a newer version of git installed in it that is used for trailers in some rules.

Okey.

There needs to be a lot more packages built than @commitlint/cli and @commitlint/config-conventional. If we only package and install these, then all the decencies of @commitlint/cli get installed from npm. This will cause issues with packages like @commitlint/types being out of sync with the CLI package.

I will add these changes.

Do we really want to me setting the entrypoint of the image. I think this will only cause issues when trying to use this in CI environment. I think it will also need to be reset in GitHub action, like you have done in the docs.

https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#entrypoint

I think the next steps for this is for me to take this branch and bring it under the commitlint repo. This way, we will be able to use the docker credentials to test pushing on a separate branch. Is that OK with you?

Sure, but first i will incorporate your review comments.

kaiehrhardt · 2023-02-16T15:06:13Z

Sure, but first i will incorporate your review comments.

Done.

AdeAttwood · 2023-02-16T15:15:48Z

This is cool, I am still not sure about using GCP for container hosting. I always thought that you needed to pay for there container hosting.

shanduur · 2023-02-16T15:17:57Z

@AdeAttwood GHCR is GitHub Container Registry, not GCR (GCP Container Registry).

AdeAttwood · 2023-02-16T16:09:53Z

Really sorry, my bad. I have had a go at setting this up and have hit a couple of issues.

I do not have the permissions to make the container package public on the conventional-changelog org this needs to be done by the organization administrators. @escapedcat don't know if yo can help with this.
I can't seem to create an access token only targeting the commitlint packages. If I create a token, it will be able to publish packages to any GitHub package repo I have access to. Unfortunately, I don't think I will be able to use one of my tokens.

kaiehrhardt · 2023-02-21T10:45:30Z

I do not have the permissions to make the container package public on the conventional-changelog org this needs to be done by the organization administrators. @escapedcat don't know if yo can help with this.

We definitely need help from a org maintainer.

I can't seem to create an access token only targeting the commitlint packages. If I create a token, it will be able to publish packages to any GitHub package repo I have access to. Unfortunately, I don't think I will be able to use one of my tokens.

https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts#personal-accounts

Tip: Personal accounts are intended for humans, but you can create accounts to automate activity on GitHub. This type of account is called a machine user. For example, you can create a machine user account to automate continuous integration (CI) workflows.

kaiehrhardt · 2023-03-18T23:02:30Z

so you guys go now with github actions? #3549

i could migrate the mr, if you're still interested.

escapedcat · 2023-03-19T18:27:07Z

Thanks @kaiehrhardt , tbh I'm as bit lost when it comes to permissions and contacting org maintainers.
Would it be possible to open an issue with requirements/what is needed and we try to tag a maintainer?

kaiehrhardt · 2023-03-30T12:29:45Z

Thanks @kaiehrhardt , tbh I'm as bit lost when it comes to permissions and contacting org maintainers. Would it be possible to open an issue with requirements/what is needed and we try to tag a maintainer?

We don't need any special creds, because it's build-in.

Changes are done. Tags look like this.

Test: https://github.com/kaiehrhardt/commitlint/actions/runs/4564227536

kaiehrhardt · 2023-04-06T20:55:39Z

ping @escapedcat

kaiehrhardt · 2023-04-14T20:34:24Z

ping @escapedcat

escapedcat · 2023-04-16T13:35:36Z

Sorry @kaiehrhardt
In general I guess we can merge this. Maybe @AdeAttwood can give a 👍 .

@kaiehrhardt would you be able to maintain this in the future? I.e. if something like this needs tp be updated?

shanduur · 2023-04-16T16:42:39Z

@escapedcat @kaiehrhardt this probably should be parametrized using ARG, and set inside CI instead of being hardcoded in Dockerfile.

kaiehrhardt · 2023-04-16T20:14:02Z

@escapedcat @kaiehrhardt this probably should be parametrized using ARG, and set inside CI instead of being hardcoded in Dockerfile.

nah hardcoded is ok -> fixed with dep automation https://github.com/conventional-changelog/commitlint/blob/2b5def1a2eb84053f13d2aae4b59d2d348ff3dd9/.github/dependabot.yml

Sorry @kaiehrhardt In general I guess we can merge this. Maybe @AdeAttwood can give a 👍 .

@kaiehrhardt would you be able to maintain this in the future? I.e. if something like this needs tp be updated?

Just tag me, if you need help in a issue or pr.

Maybe add some CODEOWNERS (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) and add me there.

kaiehrhardt · 2023-04-16T20:34:55Z

hm, maybe we don't need dependabot, since you use renovate https://github.com/conventional-changelog/commitlint/blob/master/package.json#L41-L56. Renovate should autodetect the Dockerfile.

AdeAttwood · 2023-04-17T07:25:55Z

Hi all, everything looks cool with this and I can't see any reason this cant be merged, the only thing I am concert about with this is host on GitHub and being actually able to use it. I pushed the hello world image to ghcr.io/conventional-changelog/commitlint:latest can someone have a quick test someone other than me or @escapedcat can pull this image.

kaiehrhardt · 2023-04-17T10:52:06Z

Error response from daemon: denied

https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#pushing-container-images

When you first publish a package, the default visibility is private. To change the visibility or set access permissions, see "Configuring a package's access control and visibility." You can link a published package to a repository using the user interface or command line. For more information, see "Connecting a repository to a package."

AdeAttwood · 2023-04-17T17:07:53Z

@kaiehrhardt this is what I tried before #3431 (comment), I don't know how we can get hold of someone who can @escapedcat any ideas.

kaiehrhardt · 2023-04-17T22:23:34Z

we need this :/

org -> settings -> packages

or just go with dockerhub? could you add github action secrets?

kaiehrhardt · 2023-05-04T05:36:05Z

Ping

escapedcat · 2023-05-04T07:51:27Z

Hey @kaiehrhardt , sorry, nothing new from my side... I wrote bcoe because he might be able able to help with the org settings but no reply so far. Do we have any alternatives?

kaiehrhardt · 2023-05-04T08:01:50Z

Hey @escapedcat

or just go with dockerhub? could you add github action secrets?

escapedcat · 2023-05-04T09:17:22Z

Coule be done here I guess:
https://github.com/conventional-changelog/commitlint/settings/secrets/actions

Let's try this? What should I add there?

kaiehrhardt · 2023-05-04T19:18:18Z

dockerhub username and token

        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

escapedcat · 2023-05-05T10:10:30Z

@AdeAttwood I guess you created this, right?: https://hub.docker.com/u/commitlint
Wanna add the creds to the settings?

kaiehrhardt · 2023-07-13T19:16:36Z

@AdeAttwood @escapedcat any news here?

escapedcat · 2023-07-14T02:40:36Z

So far not :(
Was hoping that Ade created that docker-account and can add the creds.

kaiehrhardt · 2023-09-22T20:25:52Z

@escapedcat should we go with a new account to get this finally merged?

escapedcat · 2023-09-24T09:09:19Z

Yeah, will create a new one and get back to you
/cc @AdeAttwood

.github/workflows/container-build.yml

escapedcat · 2023-09-25T11:24:39Z

@AdeAttwood please merge when you're good with this
@kaiehrhardt sorry it took so long

escapedcat · 2023-10-02T17:03:57Z

Looks like images from rennovate PRs are being created? Do we want/need this?

shanduur · 2023-10-02T17:17:17Z

No, why is building form EVERY tag and EVERY branch? This should be built only for releases and “nightly” master builds.

shanduur · 2023-10-03T09:08:04Z

Added #3674 to fix that.

kaiehrhardt marked this pull request as ready for review December 8, 2022 00:24

escapedcat mentioned this pull request Dec 13, 2022

feat: build and publish OCI image #3423

Closed

4 tasks

shanduur approved these changes Dec 13, 2022

View reviewed changes

AdeAttwood requested changes Sep 25, 2023

View reviewed changes

.github/workflows/container-build.yml Outdated Show resolved Hide resolved

chore(container): add initial container wrapper and build action

56e2f19

AdeAttwood merged commit c538d3c into conventional-changelog:master Sep 25, 2023

kaiehrhardt deleted the dockerfile-ci branch September 25, 2023 15:00

Loonz206 mentioned this pull request Aug 10, 2024

[Snyk] Upgrade: , Loonz206/users#61

Closed

ramzimalhas mentioned this pull request Aug 21, 2024

[Snyk] Upgrade: , ramzimalhas/standard-sdk-js-comake#3

Open

provide ci and container image #3431

provide ci and container image #3431

Conversation

kaiehrhardt commented Dec 6, 2022 • edited Loading

Description

Motivation and Context

Usage examples

How Has This Been Tested?

Types of changes

Checklist:

kaiehrhardt commented Dec 8, 2022

kaiehrhardt commented Dec 13, 2022

AdeAttwood commented Jan 12, 2023

kaiehrhardt commented Feb 16, 2023

kaiehrhardt commented Feb 16, 2023

AdeAttwood commented Feb 16, 2023

shanduur commented Feb 16, 2023 • edited Loading

AdeAttwood commented Feb 16, 2023

kaiehrhardt commented Feb 21, 2023

kaiehrhardt commented Mar 18, 2023

escapedcat commented Mar 19, 2023

kaiehrhardt commented Mar 30, 2023 • edited Loading

kaiehrhardt commented Apr 6, 2023

kaiehrhardt commented Apr 14, 2023

escapedcat commented Apr 16, 2023

shanduur commented Apr 16, 2023

kaiehrhardt commented Apr 16, 2023

kaiehrhardt commented Apr 16, 2023

AdeAttwood commented Apr 17, 2023

kaiehrhardt commented Apr 17, 2023 • edited Loading

AdeAttwood commented Apr 17, 2023

kaiehrhardt commented Apr 17, 2023 • edited Loading

kaiehrhardt commented May 4, 2023

escapedcat commented May 4, 2023

kaiehrhardt commented May 4, 2023

escapedcat commented May 4, 2023

kaiehrhardt commented May 4, 2023 • edited Loading

escapedcat commented May 5, 2023

kaiehrhardt commented Jul 13, 2023

escapedcat commented Jul 14, 2023

kaiehrhardt commented Sep 22, 2023

escapedcat commented Sep 24, 2023

escapedcat commented Sep 25, 2023

escapedcat commented Oct 2, 2023

shanduur commented Oct 2, 2023

shanduur commented Oct 3, 2023

kaiehrhardt commented Dec 6, 2022 •

edited

Loading

shanduur commented Feb 16, 2023 •

edited

Loading

kaiehrhardt commented Mar 30, 2023 •

edited

Loading

kaiehrhardt commented Apr 17, 2023 •

edited

Loading

kaiehrhardt commented Apr 17, 2023 •

edited

Loading

kaiehrhardt commented May 4, 2023 •

edited

Loading