devcontainer.java

Java implementation of the devcontainer file specification

https://github.com/metio/devcontainer.java

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.1%) to scientific vocabulary

Keywords

devcontainer java
Last synced: 6 months ago · JSON representation

Repository

Java implementation of the devcontainer file specification

Basic Info
  • Host: GitHub
  • Owner: metio
  • License: 0bsd
  • Language: Java
  • Default Branch: main
  • Homepage:
  • Size: 64.5 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 16
Topics
devcontainer java
Created about 3 years ago · Last pushed about 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation Security Authors

README.md

devcontainer.java Chat

Java implementation for the devcontainer file specification.

Usage

Parsing

The Devcontainer class exposes methods to parse java.io.File, java.nio.file.Path, and java.lang.String values.

```java import wtf.metio.devcontainer.Devcontainer; import java.nio.file.Paths;

// parse JSON file Devcontainer devcontainer = Devcontainer.parse(Paths.get("path/to/devcontainer.json"));

// parse JSON string Devcontainer devcontainer = Devcontainer.parse(""" { "image": "docker.io/someuser/someimage:someversion" } """);

// access properties String image = devcontainer.image(); ```

Building

The Devcontainer class is annotated with record-builder annotations which allow you to create new Devcontainer instances like this:

java Devcontainer devcontainer = Devcontainer.builder() .image("docker.io/someuser/someimage:someversion") .create()

All records in this project support withers and return a new instance of themselves using the new value:

java Devcontainer devcontainer = ... Devcontainer changed = devcontainer.withImage("quay.io/other/image:version");

Integration

In order to use this library in your project, declare the following dependency:

xml <dependency> <groupId>wtf.metio.devcontainer</groupId> <artifactId>devcontainer.java</artifactId> <version>${devcontainer-version}</version> </dependency>

Replace ${devcontainer-version} with the latest release.

License

``` Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ```

Mirrors

  • https://github.com/metio/devcontainer.java
  • https://gitlab.com/metio.wtf/devcontainer.java
  • https://bitbucket.org/metio-wtf/devcontainer.java
  • https://codeberg.org/metio.wtf/devcontainer.java

Owner

  • Name: metio.wtf
  • Login: metio
  • Kind: organization

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 24
  • Average time to close issues: N/A
  • Average time to close pull requests: 24 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.38
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • sebhoss (22)
  • dependabot[bot] (3)
Top Labels
Issue Labels
Pull Request Labels
enhancement (18) dependencies (3)

Dependencies

.github/actions/managed-java/action.yml actions
  • actions/setup-java v3 composite
.github/actions/managed-maven/action.yml actions
  • actions/setup-java v3 composite
.github/workflows/codeql-analysis.yml actions
  • ./.github/actions/managed-java * composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/release.yml actions
  • ./.github/actions/managed-maven * composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • dawidd6/action-send-mail v3.7.1 composite
  • s3krit/matrix-message-action v0.0.3 composite
  • softprops/action-gh-release v1 composite
  • timheuer/base64-to-file v1.2 composite
.github/workflows/reuse.yml actions
  • actions/checkout v3 composite
  • fsfe/reuse-action v1 composite
.github/workflows/update-parent.yml actions
  • ./.github/actions/managed-java * composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • peter-evans/create-pull-request v4 composite
  • peter-evans/enable-pull-request-automerge v2 composite
.github/workflows/verify.yml actions
  • ./.github/actions/managed-java * composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
pom.xml maven
  • io.soabase.record-builder:record-builder-core 35 provided
  • com.fasterxml.jackson.core:jackson-core
  • com.fasterxml.jackson.core:jackson-databind
  • org.junit.jupiter:junit-jupiter-api test