Skip to content

Commit

Permalink
Repo rename (#505)
Browse files Browse the repository at this point in the history
  • Loading branch information
DerekRoberts authored Oct 18, 2022
1 parent 26141be commit f6d3700
Show file tree
Hide file tree
Showing 14 changed files with 40 additions and 42 deletions.
4 changes: 2 additions & 2 deletions .github/openshift/deploy.backend.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ labels:
parameters:
- name: NAME
description: Module name
value: devops-quickstart
value: nr-quickstart-typescript
- name: COMPONENT
description: Component name
value: backend
Expand All @@ -27,7 +27,7 @@ parameters:
value: ghcr.io
- name: PROMOTE
description: Image (namespace/name:tag) to promote/import
value: bcgov/devops-quickstart:prod-backend
value: bcgov/nr-quickstart-typescript:prod-backend
objects:
- apiVersion: v1
kind: ImageStream
Expand Down
2 changes: 1 addition & 1 deletion .github/openshift/deploy.database.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ labels:
parameters:
- name: NAME
description: Product name
value: devops-quickstart
value: nr-quickstart-typescript
- name: COMPONENT
description: Component name
value: database
Expand Down
4 changes: 2 additions & 2 deletions .github/openshift/deploy.frontend.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ labels:
parameters:
- name: NAME
description: Module name
value: devops-quickstart
value: nr-quickstart-typescript
- name: COMPONENT
description: Component name
value: frontend
Expand All @@ -27,7 +27,7 @@ parameters:
value: ghcr.io
- name: PROMOTE
description: Image (namespace/name:tag) to promote/import
value: bcgov/devops-quickstart:prod-frontend
value: bcgov/nr-quickstart-typescript:prod-frontend
objects:
- apiVersion: v1
kind: ImageStream
Expand Down
2 changes: 1 addition & 1 deletion .github/openshift/networkPolicies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: ${NAME}
annotations:
description: "DevOps QuickStart"
tags: "devops-quickstart"
tags: "nr-quickstart-typescript"
iconClass: icon-js
objects:
- apiVersion: networking.k8s.io/v1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/merge-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:

env:
REGISTRY: ghcr.io
NAME: devops-quickstart
NAME: nr-quickstart-typescript

concurrency:
group: ${{ github.workflow }}
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/pr-close.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
- "**.md"

env:
name: devops-quickstart
name: nr-quickstart-typescript

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand All @@ -34,12 +34,12 @@ jobs:
image-promotions:
name: Image Promotions
if: github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main'
uses: bcgov/devops-quickstart-helpers/.github/workflows/_image_promote.yml@main
uses: bcgov/nr-quickstart-helpers/.github/workflows/_image_promote.yml@main
strategy:
matrix:
component: [backend, frontend]
with:
app_name: devops-quickstart
app_name: nr-quickstart-typescript
component: ${{ matrix.component }}
env_source: ${{ github.event.number }}
env_target: test
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/pr-open.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ concurrency:
jobs:
builds:
name: Builds
uses: bcgov/devops-quickstart-helpers/.github/workflows/_build.yml@main
uses: bcgov/nr-quickstart-helpers/.github/workflows/_build.yml@main
strategy:
matrix:
component: [backend, frontend]
Expand All @@ -29,7 +29,7 @@ jobs:

tests:
name: Unit Tests
uses: bcgov/devops-quickstart-helpers/.github/workflows/_code-cov.yml@main
uses: bcgov/nr-quickstart-helpers/.github/workflows/_code-cov.yml@main
strategy:
matrix:
component: [backend, frontend]
Expand Down Expand Up @@ -89,7 +89,7 @@ jobs:
- builds
# If any of the prerequs created a build, then deploy
if: contains(needs.*.outputs.build, 'true')
uses: bcgov/devops-quickstart-helpers/.github/workflows/_deploy.yml@main
uses: bcgov/nr-quickstart-helpers/.github/workflows/_deploy.yml@main
strategy:
matrix:
component: [backend, database, frontend]
Expand Down Expand Up @@ -122,7 +122,7 @@ jobs:
- deploys
env:
DOMAIN: apps.silver.devops.gov.bc.ca
NAME: devops-quickstart
NAME: nr-quickstart-typescript
runs-on: ubuntu-22.04
steps:
- name: Comment with links
Expand Down
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
<!-- PROJECT SHIELDS -->

[![Contributors](https://img.shields.io/github/contributors/bcgov/devops-quickstart)](/../../graphs/contributors)
[![Forks](https://img.shields.io/github/forks/bcgov/devops-quickstart)](/../../network/members)
[![Stargazers](https://img.shields.io/github/stars/bcgov/devops-quickstart)](/../../stargazers)
[![Issues](https://img.shields.io/github/issues/bcgov/devops-quickstart)](/../../issues)
[![MIT License](https://img.shields.io/github/license/bcgov/devops-quickstart.svg)](/LICENSE.md)
[![Contributors](https://img.shields.io/github/contributors/bcgov/nr-quickstart-typescript)](/../../graphs/contributors)
[![Forks](https://img.shields.io/github/forks/bcgov/nr-quickstart-typescript)](/../../network/members)
[![Stargazers](https://img.shields.io/github/stars/bcgov/nr-quickstart-typescript)](/../../stargazers)
[![Issues](https://img.shields.io/github/issues/bcgov/nr-quickstart-typescript)](/../../issues)
[![MIT License](https://img.shields.io/github/license/bcgov/nr-quickstart-typescript.svg)](/LICENSE.md)
[![Lifecycle](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)

# DevOps QuickStart (formerly Greenfield Template)
# Natural Resources QuickStart for TypeScript

Courtesy of the Forestry Suite of Applications Program from the Ministry of Land, Water and Resource Stewardship.

UPDATE: We are of splitting this offering into a quickstart template and helper functions. Please be on the lookup for progress, releases and new features!

## Getting Started

Initial configuration is expected to take under three hours. Please read [our setup guide](./SETUP.md) to get started.

## Overview

The DevOps Quickstart is a fully functional set of pipeline workflows and a starter application stack intended to help Agile DevOps teams hit the ground running. Currently OpenShift is supported with plans for AWS (Amazon Web Services). Pipelines are run using [GitHub Actions](https://github.com/bcgov/devops-quickstart/actions).
The DevOps Quickstart is a fully functional set of pipeline workflows and a starter application stack intended to help Agile DevOps teams hit the ground running. Currently OpenShift is supported with plans for AWS (Amazon Web Services). Pipelines are run using [GitHub Actions](https://github.com/bcgov/nr-quickstart-typescript/actions).

Features:
* Pull Request-based pipeline
Expand All @@ -32,7 +30,7 @@ Features:
* Templates and setup documentation
* Starter TypeScript application stack

This project is in active development. Please visit our [issues](https://github.com/bcgov/devops-quickstart/issues) page to view or request features.
This project is in active development. Please visit our [issues](https://github.com/bcgov/nr-quickstart-typescript/issues) page to view or request features.

### Workflow 1 of 3: PR Open

Expand Down Expand Up @@ -124,12 +122,12 @@ Optionally, higher-level deployments can be prevented until manually approved.

This workflow is triggered when a Pull Request to the main branch is created or modified. Each development deployment is separate, using its own stack. This avoids collisions between development environments and provides isolation for testing and experimentation. Pipeline steps are enforced, preventing merge of failing code.

The workflow, located [here](https://github.com/bcgov/devops-quickstart/blob/main/.github/workflows/pr-open.yml), includes:
The workflow, located [here](https://github.com/bcgov/nr-quickstart-typescript/blob/main/.github/workflows/pr-open.yml), includes:

* [Pull Request](https://github.com/bcgov/devops-quickstart/pulls)-based ephemeral, sandboxed environments
* [Pull Request](https://github.com/bcgov/nr-quickstart-typescript/pulls)-based ephemeral, sandboxed environments
* [Docker](https://github.com/marketplace/actions/build-and-push-docker-images)/[Podman](https://podman.io) container building
* [Build caching](https://github.com/marketplace/actions/cache) to save time and bandwidth
* [GitHub Container Registry](https://github.com/bcgov/devops-quickstart/pkgs/container/devops-quickstart) image publishing
* [GitHub Container Registry](https://github.com/bcgov/nr-quickstart-typescript/pkgs/container/nr-quickstart-typescript) image publishing
* [RedHat OpenShift](https://www.redhat.com/en/technologies/cloud-computing/openshift) deployment, with other options under consideration
* [Jest](https://jestjs.io/) JavaScript testing enforced in-pipeline
* [SonarCloud](https://sonarcloud.io/) static analysis test coverage reporting
Expand All @@ -148,7 +146,7 @@ When a PR is merged, the message comment below is added. Despite showing on thi

### 2: Pull Request Close Pipeline

The workflow, located [here](https://github.com/bcgov/devops-quickstart/blob/main/.github/workflows/pr-close.yml), fires when a pull request is closed.
The workflow, located [here](https://github.com/bcgov/nr-quickstart-typescript/blob/main/.github/workflows/pr-close.yml), fires when a pull request is closed.

* ghcr.io cleanup of dev images over 14 days-old
* OpenShift dev artifact removal
Expand All @@ -163,7 +161,7 @@ If this closure was triggered by a merge to the main branch it will trigger the

### 3: Pull Request Main Merge Pipeline

The workflow, located [here](https://github.com/bcgov/devops-quickstart/blob/main/.github/workflows/merge-main.yml), includes:
The workflow, located [here](https://github.com/bcgov/nr-quickstart-typescript/blob/main/.github/workflows/merge-main.yml), includes:

* [GitHub CodeQL](https://codeql.github.com/) semantic code analysis and vulerability scanning
* [OWASP ZAP](https://www.zaproxy.org/) Zed Attack Proxy web app penetration testing
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This product currently has no support and is experimental. That could change in

## Reporting a Vulnerability

Please report any issues or vulerabilities with an [issue](https://github.com/bcgov/devops-quickstart/issues).
Please report any issues or vulerabilities with an [issue](https://github.com/bcgov/nr-quickstart-typescript/issues).
4 changes: 2 additions & 2 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following are required:
![image](./.github/graphics/newRepo.png)

Create a new repository using this repository as a template.
* Select bcgov/devops-quickstart under Repository template
* Select bcgov/nr-quickstart-typescript under Repository template
* Check Codecov | Code Coverage to grant access
* Jira cannot be unchecked (I try every time!)

Expand Down Expand Up @@ -249,7 +249,7 @@ From your GitHub repository:
Packages are available from your repository (link on right) or your organization's package lists.
E.g. https://github.com/orgs/bcgov/packages?repo_name=devops-quickstart
E.g. https://github.com/orgs/bcgov/packages?repo_name=nr-quickstart-typescript
### Branch Protection
Expand Down
2 changes: 1 addition & 1 deletion backend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions backend/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "devops-quickstart",
"name": "nr-quickstart-typescript",
"version": "0.0.1",
"description": "BCGov devops quickstart. For reference, testing and new projects.",
"main": "index.js",
Expand All @@ -23,7 +23,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/bcgov/devops-quickstart.git"
"url": "git+https://github.com/bcgov/nr-quickstart-typescript.git"
},
"keywords": [
"openshift",
Expand All @@ -36,9 +36,9 @@
"author": "Derek Roberts",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/bcgov/devops-quickstart/issues"
"url": "https://github.com/bcgov/nr-quickstart-typescript/issues"
},
"homepage": "https://github.com/bcgov/devops-quickstart#readme",
"homepage": "https://github.com/bcgov/nr-quickstart-typescript#readme",
"dependencies": {
"@nestjs/cli": "^8.2.6",
"@nestjs/common": "^8.4.6",
Expand Down
2 changes: 1 addition & 1 deletion frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions frontend/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "devops-quickstart",
"name": "nr-quickstart-typescript",
"version": "0.0.1",
"description": "BCGov devops quickstart template. For reference, testing and new projects.",
"main": "index.js",
Expand All @@ -23,7 +23,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/bcgov/devops-quickstart.git"
"url": "git+https://github.com/bcgov/nr-quickstart-typescript.git"
},
"keywords": [
"openshift",
Expand All @@ -36,9 +36,9 @@
"author": "Derek Roberts",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/bcgov/devops-quickstart/issues"
"url": "https://github.com/bcgov/nr-quickstart-typescript/issues"
},
"homepage": "https://github.com/bcgov/devops-quickstart#readme",
"homepage": "https://github.com/bcgov/nr-quickstart-typescript#readme",
"dependencies": {
"@nestjs/cli": "^8.2.6",
"@nestjs/common": "^8.4.6",
Expand Down

0 comments on commit f6d3700

Please sign in to comment.