Skip to content

Commit

Permalink
add doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
tsirysndr committed Aug 25, 2023
1 parent 61d32ae commit 5bc800c
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/aws/config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { BuildSpec } from "fluent_aws_codepipeline";

/**
* Generates a BuildSpec object for AWS CodePipeline.
* @returns A BuildSpec object containing the installation, build, and post-build phases.
*/
export function generateYaml(): BuildSpec {
const buildspec = new BuildSpec();
buildspec
Expand Down
4 changes: 4 additions & 0 deletions src/azure/config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { AzurePipeline } from "fluent_azure_pipelines";

/**
* Generates Azure Pipeline YAML configuration.
* @returns {AzurePipeline} An instance of AzurePipeline class.
*/
export function generateYaml(): AzurePipeline {
const azurePipeline = new AzurePipeline();

Expand Down
4 changes: 4 additions & 0 deletions src/circleci/config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { CircleCI, Job } from "fluent_circleci";

/**
* Generates CircleCI configuration object.
* @returns {CircleCI} CircleCI configuration object.
*/
export function generateYaml(): CircleCI {
const circleci = new CircleCI();

Expand Down
4 changes: 4 additions & 0 deletions src/github/config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { JobSpec, Workflow } from "fluent_github_actions";

/**
* Generates a GitHub Actions workflow for testing a Django pipeline.
* @returns The generated workflow.
*/
export function generateYaml(): Workflow {
const workflow = new Workflow("Test");

Expand Down
4 changes: 4 additions & 0 deletions src/gitlab/config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { GitlabCI, Job } from "fluent_gitlab_ci";

/**
* Generates GitLab CI YAML configuration.
* @returns {GitlabCI} GitLab CI configuration.
*/
export function generateYaml(): GitlabCI {
const docker = new Job()
.image("denoland/deno:alpine")
Expand Down

0 comments on commit 5bc800c

Please sign in to comment.