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

feat: add Github Codespaces development environment support #570

Merged
merged 2 commits into from
Jun 7, 2023

Conversation

niconical
Copy link
Contributor

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

  • N
  • Y

fix #396

Related PR: #568

2. What is the scope of this PR (e.g. component or file name):

  • .devcontainer/devcontainer.json

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

@niconical niconical changed the title feat: add Github Codespaces development environment support [WIP] feat: add Github Codespaces development environment support Jun 7, 2023
@coveralls
Copy link
Collaborator

coveralls commented Jun 7, 2023

Pull Request Test Coverage Report for Build 5200758152

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 31 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-20.0%) to 68.035%

Files with Coverage Reduction New Missed Lines %
compiler_base/session/src/lib.rs 31 50.0%
Totals Coverage Status
Change from base Build 5195718110: -20.0%
Covered Lines: 30824
Relevant Lines: 45306

💛 - Coveralls

@niconical
Copy link
Contributor Author

niconical commented Jun 7, 2023

Usually, the image tag is used in the .devcontainer.json file instead of the build tag, which allows Github Codespace to start up more quickly by avoiding the time it takes to build the image. However, the kclvm-builder:latest image on Dockerhub hasn't been updated in three months. I need to wait for the new kclvm-builder image, which includes PR #568, to be available on Dockerhub.

It seems that the CI/CD needs to be modified to always push the latest version of the kclvm-builder image in a timely manner.

      # KCLVM docker image build and upload

      - name: Copy Dockerfile to the current work directory
        run: cp scripts/docker/kclvm/Dockerfile .
        shell: bash
      - name: Login to Docker Hub
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
      - name: Extract metadata (tags, labels) for Docker
        id: meta
        uses: docker/metadata-action@v4
        with:
          images: kusionstack/kclvm
      - name: Build and push Docker image
        uses: docker/build-push-action@v3
        with:
          context: .
          push: ${{ github.event_name != 'pull_request' }}
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}

@Peefy
Copy link
Contributor

Peefy commented Jun 7, 2023

@niconical Thank you for reminding me. I just updated the image kusionstack/kclvm-builder:latest on the Dockerhub. Besides, U can add a link in English and Chinese readme documents as follows:
image

Ref: https://github.com/KusionStack/konfig/blob/main/.devcontainer.json

@niconical
Copy link
Contributor Author

@niconical Thank you for reminding me. I just updated the image kusionstack/kclvm-builder:latest on the Dockerhub. Besides, U can add a link in English and Chinese readme documents as follows: image

Ref: https://github.com/KusionStack/konfig/blob/main/.devcontainer.json

I will update related docs.

@Peefy Peefy added the release label Jun 7, 2023
@Peefy Peefy added this to the v0.5.0 Release milestone Jun 7, 2023
@Peefy Peefy changed the title [WIP] feat: add Github Codespaces development environment support feat: add Github Codespaces development environment support Jun 7, 2023
Copy link
Contributor

@Peefy Peefy left a comment

Choose a reason for hiding this comment

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

LGTM! Good Job! ❤️

@Peefy Peefy merged commit 633f54d into kcl-lang:main Jun 7, 2023
10 of 11 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jun 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement] Add GitPod or Github Codespaces development environment support for KCLVM
3 participants