Skip to content

Commit

Permalink
Merge pull request #117 from JeremiahSanders/release/1.0.0
Browse files Browse the repository at this point in the history
Release/1.0.0
  • Loading branch information
JeremiahSanders authored Jun 5, 2022
2 parents 4d67854 + fa7fda7 commit 9a71da6
Show file tree
Hide file tree
Showing 6 changed files with 73 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .project-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "cicee",
"description": "Runs continuous integration workloads via docker-compose, locally or on a build server.",
"title": "Continuous Integration Containerized Execution Environment (CICEE)",
"version": "0.12.1",
"version": "1.0.0",
"ciEnvironment": {
"variables": [
{
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ CICEE also provides a [continuous integration shell function library][cicee-lib]
* `bash`: bash shell
* `docker`: Docker command-line interface
* `docker-compose`: Docker Compose command-line interface (compose file version `3.7` support required)
* `dotnet`:- .NET runtime (`5` and `6` supported)
* `dotnet`: .NET runtime (`6.x` supported)

## Why use CICEE?

Expand Down
67 changes: 67 additions & 0 deletions docs/use/env-require.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Require Environment Contains Variables

Require that the environment contains all required variables. For example, require that a database `CONNECTION_STRING` is set.

```bash
$ cicee env require --help
Description:
Require that the environment contains all required variables.

Usage:
cicee env require [options]

Options:
-p, --project-root <project-root> Project repository root directory [default: C:\Users\gnosi\source\repos\cicee]
-f, --file <file> Project metadata file.
-?, -h, --help Show help and usage information
```

## Configuring Project CI Environment

See `project metadata` in [project structure][].

## Example

The following example shows a `project-metadata.json` for a .NET library published to nuget.org. In this example, the `NUGET_API_KEY` is required.

```json
{
"ciEnvironment": {
"variables": [
{
"description": "NuGet API Key",
"name": "NUGET_API_KEY",
"required": true,
"secret": true
}
]
},
"name": "neat-project-name",
"title": "The NEAT Project",
"version": "0.7.2"
}
```

When the required variables are not present:

```bash
$ cicee env require

-- cicee (v0.12.1) --

Environment validation failed.
Reason: Missing environment variables: NUGET_API_KEY
```

When the required variables are present:

```bash
$ cicee env require

-- cicee (v0.12.1) --

Environment validation succeeded.
Metadata file: /home/user/neat-project-name/project-metadata.json
```

[project structure]: ./project-structure.md
2 changes: 2 additions & 0 deletions docs/use/using-cicee.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Commands:
## Commands

* `env` - Commands which interact with the current environment.
* [`require`][env-require] - Require that the environment contains all required variables.
* [`exec`][execute] - [Execute a command][execute] in a containerized execution environment.
* [`init`][initialize] - [Initialize project CI containerization files][initialize]. Creates suggested cicee files.
* [`lib`][lib] - Commands working with [CICEE shell script library][lib].
Expand All @@ -34,6 +35,7 @@ Commands:

[docker-compose-command]: https://docs.docker.com/compose/compose-file/compose-file-v3/#command
[docker-compose-entrypoint]: https://docs.docker.com/compose/compose-file/compose-file-v3/#entrypoint
[env-require]: ./env-require.md
[execute]: ./execute.md
[initialize]: ./initialize.md
[lib]: ./ci-library.md
Expand Down
2 changes: 1 addition & 1 deletion src/Cicee.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<LangVersion>10</LangVersion>
<Nullable>enable</Nullable>
<OutputType>Exe</OutputType>
<TargetFrameworks>net6.0;net5.0</TargetFrameworks>
<TargetFramework>net6.0</TargetFramework>
</PropertyGroup>

<PropertyGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ CICEE also provides a [continuous integration shell function library][cicee-lib]
* `bash`: bash shell
* `docker`: Docker command-line interface
* `docker-compose`: Docker Compose command-line interface (compose file version `3.7` support required)
* `dotnet`:- .NET runtime (`5` and `6` supported)
* `dotnet`: .NET runtime (`6.x` supported)

## Why use CICEE?

Expand Down

0 comments on commit 9a71da6

Please sign in to comment.