From a8aba88ff85f45d1f03cfb91611d0cccbc1e5418 Mon Sep 17 00:00:00 2001 From: CD Cabrera Date: Thu, 19 Aug 2021 16:52:41 -0400 Subject: [PATCH] chore(build): default branch to main (#769) --- .travis/custom_release.sh | 2 +- CONTRIBUTING.md | 22 +++++++++++----------- README.md | 6 +++--- src/services/rhsmServices.js | 12 ++++++------ src/services/userServices.js | 6 +++--- 5 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.travis/custom_release.sh b/.travis/custom_release.sh index 28c3e0236..0d5a1ad66 100755 --- a/.travis/custom_release.sh +++ b/.travis/custom_release.sh @@ -30,7 +30,7 @@ releaseDev() } # # -# Prod release for "master" and "stage" branches based on deploy stage name. +# Prod release for "main" and "stage" branches based on deploy stage name. # releaseProd() { diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee3e8053a..5d2f55209 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,9 +64,9 @@ For Github issues that looks like Settings for [Standard Version](https://github.com/conventional-changelog/standard-version#readme) can be found in [package.json](./package.json) ### Branching, Pull Requests, and Releases -Curiosity makes use of the branches `master`, `stage`, `qa`, and `ci`. -- `master` branch is a protected representation of production environments - - Adding commits, or a PR, into `master` should generate a `prod-stable` branch within the deploy repository [curiosity-frontend-build](https://github.com/RedHatInsights/curiosity-frontend-build) +Curiosity makes use of the branches `main`, `stage`, `qa`, and `ci`. +- `main` branch is a protected representation of production environments + - Adding commits, or a PR, into `main` should generate a `prod-stable` branch within the deploy repository [curiosity-frontend-build](https://github.com/RedHatInsights/curiosity-frontend-build) - The `prod-stable` branch is manually deployed through coordination with the operations team. - `stage` branch is a protected representation of production environments - Adding commits, or a PR, into `stage` should generate a `prod-beta` branch within the deploy repository [curiosity-frontend-build](https://github.com/RedHatInsights/curiosity-frontend-build) @@ -90,19 +90,19 @@ It is required that all work is handled through GitHub's fork and pull workflow. 1 PRs from `ci` to `qa` are allowed 1. PRs from `qa` to `stage` are preferred. 1. PRs to `stage` require a QE team members approval/sign-off. -1. PRs to `master` are only allowed from `stage`. -1. PRs to `master` branch are considered production ready releases. -1. Development or testing PRs opened against master, unless a team agreed exception occurs, will be closed. -1. All PRs to production, master branch, should have a final review, coordination, from Quality Engineering. +1. PRs to `main` are only allowed from `stage`. +1. PRs to `main` branch are considered production ready releases. +1. Development or testing PRs opened against main, unless a team agreed exception occurs, will be closed. +1. All PRs to production, main branch, should have a final review, coordination, from Quality Engineering. ``` - PR fork -> ci <-> qa -> stage -> master + PR fork -> ci <-> qa -> stage -> main ``` ### Releases and Tagging -1. Merging a PR into `master` is considered production ready. -1. Merging a PR into `master` doesn't require tagging and [CHANGELOG.md](./CHANGELOG.md) updates. -1. Running `$ yarn release` after commits are merged into `master` generates the release commit and [CHANGELOG.md](./CHANGELOG.md). You may need to update/pull tags prior to running this command. This commit should be pushed towards `master`. This release commit is currently used as a purposeful block and may be automated in the future. [The commit message is recognized in the release script](./.travis/custom_release.sh#L41). This commit format controls when files are pushed towards production stable, and gives development a fallback when something goes wrong. +1. Merging a PR into `main` is considered production ready. +1. Merging a PR into `main` doesn't require tagging and [CHANGELOG.md](./CHANGELOG.md) updates. +1. Running `$ yarn release` after commits are merged into `main` generates the release commit and [CHANGELOG.md](./CHANGELOG.md). You may need to update/pull tags prior to running this command. This commit should be pushed towards `main`. This release commit is currently used as a purposeful block and may be automated in the future. [The commit message is recognized in the release script](./.travis/custom_release.sh#L41). This commit format controls when files are pushed towards production stable, and gives development a fallback when something goes wrong. 1. Tagging and `CHANGELOG.md` updates should be coordinated against a consistent release cycle, and can take place at an independent time. 1. Tagging should make use of semver. 1. Manipulating tags against commits directly should be avoided in favor of a semantic version increment, iteration. diff --git a/README.md b/README.md index 97a05ed9b..2f4307889 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Curiosity Frontend -[![Build Status](https://travis-ci.org/RedHatInsights/curiosity-frontend.svg?branch=master)](https://travis-ci.org/RedHatInsights/curiosity-frontend) -[![codecov](https://codecov.io/gh/RedHatInsights/curiosity-frontend/branch/master/graph/badge.svg)](https://codecov.io/gh/RedHatInsights/curiosity-frontend) -[![License](https://img.shields.io/github/license/RedHatInsights/curiosity-frontend.svg)](https://github.com/RedHatInsights/curiosity-frontend/blob/master/LICENSE) +[![Build Status](https://travis-ci.org/RedHatInsights/curiosity-frontend.svg?branch=main)](https://travis-ci.org/RedHatInsights/curiosity-frontend) +[![codecov](https://codecov.io/gh/RedHatInsights/curiosity-frontend/branch/main/graph/badge.svg)](https://codecov.io/gh/RedHatInsights/curiosity-frontend) +[![License](https://img.shields.io/github/license/RedHatInsights/curiosity-frontend.svg)](https://github.com/RedHatInsights/curiosity-frontend/blob/main/LICENSE) A web user interface for subscription reporting, based on [Patternfly](https://www.patternfly.org/) diff --git a/src/services/rhsmServices.js b/src/services/rhsmServices.js index f5ea42431..d7760f4cd 100644 --- a/src/services/rhsmServices.js +++ b/src/services/rhsmServices.js @@ -5,7 +5,7 @@ import { helpers } from '../common'; * @api {get} /api/rhsm-subscriptions/v1/version * @apiDescription Retrieve API version information * - * Reference [RHSM API](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM API](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK @@ -58,7 +58,7 @@ const getApiVersion = (options = {}) => { * @api {get} /api/rhsm-subscriptions/v1/tally/products/:product_id Get RHSM graph data * @apiDescription Retrieve graph data. * - * Reference [RHSM for report params and commands](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM for report params and commands](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiParam {string} product_id The ID for the product we wish to query. * - RHEL @@ -755,7 +755,7 @@ const getGraphReports = (id, params = {}, options = {}) => { * @api {get} /api/rhsm-subscriptions/v1/capacity/products/:product_id Get RHSM graph capacity data, i.e. thresholds * @apiDescription Retrieve graph capacity data, such as thresholds. * - * Reference [RHSM for capacity params and commands](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM for capacity params and commands](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK @@ -1058,7 +1058,7 @@ const getGraphCapacity = (id, params = {}, options = {}) => { * @api {get} /api/rhsm-subscriptions/v1/hosts/products/:product_id Get RHSM hosts/systems table/inventory data * @apiDescription Retrieve hosts/systems table/inventory data. * - * Reference [RHSM for hosts/system table/inventory](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM for hosts/system table/inventory](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK @@ -1263,7 +1263,7 @@ const getHostsInventory = (id, params = {}, options = {}) => { * @api {get} /api/rhsm-subscriptions/v1/hosts/:hypervisor_uuid/guests Get RHSM hosts/systems table/inventory guests data * @apiDescription Retrieve hosts/systems table/inventory guests data. * - * Reference [RHSM for hosts/system table/inventory](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM for hosts/system table/inventory](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK @@ -1391,7 +1391,7 @@ const getHostsInventoryGuests = (id, params = {}, options = {}) => { * @api {get} /api/rhsm-subscriptions/v1/subscriptions/products/:product_id Get RHSM subscriptions table/inventory data * @apiDescription Retrieve subscriptions table/inventory data. * - * Reference [RHSM for subscriptions table/inventory](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM for subscriptions table/inventory](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK diff --git a/src/services/userServices.js b/src/services/userServices.js index 8c82d8dc8..479246bf7 100644 --- a/src/services/userServices.js +++ b/src/services/userServices.js @@ -87,7 +87,7 @@ const logoutUser = () => * @api {delete} /api/rhsm-subscriptions/v1/opt-in * @apiDescription Delete a RHSM account opt-in config * - * Reference [RHSM API](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM API](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiSuccessExample {text} Success-Response: * HTTP/1.1 204 OK @@ -163,7 +163,7 @@ const deleteAccountOptIn = () => * @api {get} /api/rhsm-subscriptions/v1/opt-in * @apiDescription Get a RHSM account opt-in config * - * Reference [RHSM API](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM API](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK @@ -230,7 +230,7 @@ const getAccountOptIn = (options = {}) => { * @apiDescription Create/Update an account's opt-in configuration. Account and Org ID are defined by * the identity header. If no parameters are specified, everything will be enabled. * - * Reference [RHSM API](https://github.com/RedHatInsights/rhsm-subscriptions/blob/master/api/rhsm-subscriptions-api-spec.yaml) + * Reference [RHSM API](https://github.com/RedHatInsights/rhsm-subscriptions/blob/main/api/rhsm-subscriptions-api-spec.yaml) * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK