Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(build): default branch to main #769

Merged
merged 1 commit into from
Aug 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis/custom_release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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()
{
Expand Down
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)

Expand Down
12 changes: 6 additions & 6 deletions src/services/rhsmServices.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/services/userServices.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down